HamCall (April 1991)

home *** CD-ROM | disk | FTP | other *** search

/ HamCall (April 1991) / HAMCALL CD-ROM (Buckmaster)(April 1991).BIN / telcom / qmodem / qmdoc.40 / QMDOC.TXT

Wrap

Text File | 1989-02-27 | 607KB | 17,061 lines

Qmodem Operations Manual ______________________________________________________________________ Version 4.0 Preface ______________________________________________________________________ This document was revised for Qmodem 4.0. Qmodemσ software copyright π 1989 The Forbin Project, Inc. All rights reserved. This document copyright π 1989 The Forbin Project, Inc. All rights reserved. Qmodem is a Trademark of The Forbin Project, Inc. Any specific hardware/software names used in this document are trademarks of specific manufacturers. How to Contact The Forbin Project ______________________________________________________________________ The best way to get hold of us, is to log on to the Forbin Project BBS. We have 6 nodes running the PCBoard BBS software; 24 hours a day, 7 days a week. From the "Main Menu Command" prompt, use the (C)omment command. Turn-around time for answering BBS mail is usually within 24 hours. USPS mail responses are considerably longer. The BBS has two different numbers you can call: (319) 233-6157 1200/2400/9600/19200 5 nodes with Courier HST modems. (319) 233-6006 1200/2400/9600/19200 1 node with Hayes V9600 modem. Set Qmodem up for 8 data bits, No Parity and 1 stop bit. We also run a Qmodem Support Roundtable on the General Electric GEnie system. Type "QMODEM" at any menu prompt to get to us. If you prefer, you can write us a letter with your comments and send it to: Technical Support Department The Forbin Project, Inc. Post Office Box 702 Cedar Falls, IA 50613, USA Telephone technical support is available to registered user by dialing (319) 232-4516. Please have the following information handy before you call: o Version of Qmodem you have o Computer make and model number o Modem make and model number o Version of DOS o Copies of your CONFIG.SYS and AUTOEXEC.BAT files If you wish to place an order, this can be done on the BBS by using the (S)cript Questionaire command from the main menu. Answer questionaire (#1) and please have your Visa or Mastercard handy. You can also call us voice at the above number; we will be happy to take down the necessary information. T A B L E O F C O N T E N T S License Limited Single User License............................i Giving a copy to a friend..............................i Sysops - what you need to know.........................i Distributors of "PD" or ShareWare Software.............i Ordering Information Registration Registration only.................................ii Getting a trial diskette..........................ii Invoice order form...............................iii Site License..........................................iv Discounts.........................................iv System Requirements........................................v Warranty..................................................vi Definitions................................................1 What's new in Qmodem 4.0...................................2 Operating Environment Multi-Tasking Systems..................................3 Other Background Software..............................4 Back up your diskettes!....................................4 Floppy Disk Installation...................................4 Starting Qmodem in a Floppy Setup......................5 Hard Disk Installation.....................................6 Subdirectory Structure.................................6 ONLINE Help Getting HELP when you need it..........................7 Starting Qmodem for the First time.........................8 Configuration.............................................10 Menu Navigation.......................................11 First time setup......................................12 Colors................................................13 Custom Colors.....................................14 Pulldown normal text..........................14 Pulldown first letter.........................14 Pulldown selection bar........................15 Pulldown window border........................15 Pulldown edit field...........................15 Window border.................................15 Window primary text...........................15 Window secondary text.........................15 Window Scroll Bar.............................15 Screen border.................................15 Screen text...................................16 Information text..............................16 Status line...................................16 Online Help border............................16 Online Help text..............................16 Editor primary text...........................16 Editor marked text............................16 Editor window border..........................16 Customization Window..........................17 Modem.................................................18 Communications Parameters.........................19 Default Baud Rate.............................19 Default Data Bits.............................20 Default Parity................................20 Default Stop Bits.............................20 Command Before Baud Change....................20 Command After Baud Change.....................20 Cycle Delay...................................20 Timeout Delay.................................20 Modem Command delay...........................21 Serial Port...................................21 Modem Commands....................................22 Initialization Command........................22 Prefix Dial Command...........................22 Suffix Dial Command...........................23 Connect Message...............................23 Error Messages 1-4............................23 Abort Dial Command............................24 Hangup Command................................24 Redial Hangup Text............................25 Port Addresses....................................25 COM1-COM8 Base................................26 COM1-COM8 IRQ.................................26 Directories...........................................26 Upload............................................27 Download..........................................27 Scripts...........................................27 Host..................................................28 Type of System....................................28 Download Dir......................................29 Upload Dir........................................29 Maximum Time......................................29 DOS Password......................................29 Shutdown Password.................................30 Init Command......................................30 Answer Command....................................30 OK Message........................................30 Ring Detect.......................................30 Busy Command......................................31 Protocols.............................................31 Protocol Revisions................................32 Select Character..............................32 Protocol Name.................................32 Upload BAT....................................32 Download BAT..................................32 Filename Prompt...............................33 Installing an external protocol...................33 ASCII Options.....................................34 ASCII Receive.................................35 Use INPUT Translate Table.................35 Carriage Return Handling..................35 LineFeed Handling.........................36 ASCII Transmit................................37 Use OUTPUT Translate Table................37 Carriage Return Handling..................37 LineFeed Handling.........................38 Pacing Speed..............................38 pAcing Character..........................38 Blank Line Expansion......................38 End Of Line Character.....................39 Files.................................................40 Online Help.......................................40 Screen Dump.......................................40 Capture...........................................40 Log...............................................41 Backscroll........................................41 View..............................................41 Options...............................................42 Toggles...........................................44 Xon/Xoff......................................44 BIOS Video....................................45 PCjr mode.....................................45 Beeps & Bells.................................45 Linefeed after CR.............................45 ANSI Music....................................45 CTS Signal....................................46 CTS when Writing..............................46 Redial Sets Baud Rate.........................46 Del/^H Backspace..............................47 aUto Start Log................................47 Snow Checking.................................47 Growing Windows...............................47 sTatus Line...................................47 FIFO during Shell.............................48 Keypad emulation..............................48 Memory............................................49 Lines of Scroll-back..........................49 Script Variables..............................49 Editor Memory.................................49 Download Buffer...............................50 Overlay Buffer................................50 Sounds............................................51 Upload tone...................................51 Download tone.................................51 Connect tones.................................52 Delays............................................53 Status Windows................................53 File Transfers................................53 Characters........................................54 Date Separation...............................54 Time Separation...............................55 Beeps & Bells.................................55 ANSI Music....................................55 Status Line Filler............................55 Phone Book Tag................................55 Notes Tag.....................................56 Exit..................................................56 Abandon...........................................56 Save Changes......................................56 Upgrading from a previous release.........................56 QMODEM support files..................................58 Phone Book Files..................................58 Script Files......................................59 .KEY Files........................................59 The QMODEM.PRE File...............................61 Command Line Parameters...................................62 The Internal Editor.......................................64 Entering and Editing Text.............................64 Quick Command Reference...............................64 The Editing Screen....................................65 Basic Movement Commands...............................67 Insert and Delete Commands............................69 Block Commands........................................70 Miscellaneous Commands................................72 EDINSTAL - Keyboard Installation Program..................74 Running EDINSTAL......................................74 Fast Entry........................................75 Random Access.....................................75 Quitting the Program..............................76 The Status Line...........................................77 The Home Menu.............................................80 Qmodem Keyboard Commands..................................82 Strip/Replace Table (Alt-A).........................82 Changing an incoming character....................82 Changing the High-Bits............................84 Bells and Beeps Toggle (Alt-B)......................84 Clearing the screen (Alt-C).........................85 Dialing Directory (Alt-D)............................85 Moving around in the Directory....................87 How to use Prefixes...........................90 Revising this Screen..........................94 Untag All.....................................98 Starting the Dialer...........................99 Dialing from ALT-D...............................100 Primary Commands.................................100 Status messages..................................100 Parameters passed to the Linked Script...........102 Exiting the ALT-D window.....................102 Manual Dial mode.............................103 Editing Attached Notes.......................103 Other info in the Phone Book.................110 Changing Duplex Mode (Alt-E)........................114 Script Files (Alt-F) What is a Script?................................115 Terminal Emulation (Alt-G).........................116 Hangup the phone (Alt-H)...........................118 Information screen (Alt-I).........................119 Function Key Macros (Alt-J)........................120 Editing Key Macros...............................121 DOS Shell Macros.................................122 A Dial Macro.....................................122 An Edit Macro....................................123 A Script Macro...................................124 A LOG Macro......................................125 The $PASSWORD Variable...........................125 Loading a new Key file...........................126 Changing the active COM port (Alt-K)...............127 Changing the Logged Drive (Alt-L)..................128 Music Toggle (Alt-M)...............................129 Invoking Qinstall from Qmodem (Alt-N)..............129 Changing Subdirectories (Alt-O)....................130 Setting the Communications Parameters (Alt-P)......131 The QuickLearn Script Recorder (Alt-Q).............132 Saving the Current Setup.........................134 Commands that are recorded.......................135 Putting it all together..........................139 Sample generated script..........................144 DOS Shell (Alt-R)..................................145 Split Screen Mode (Alt-S)..........................147 Screen Dump (Alt-T)................................148 Scroll Back Toggle (Alt-U).........................148 View a File (Alt-V)................................149 Disk Directory (Alt-W).............................151 Exiting Qmodem (Alt-X).............................152 Delete a File (Alt-Y)..............................153 Xon/Xoff Toggle (Alt-Z)............................154 Uploading a File (PgUp) Protocols available..............................155 Downloading A File (PgDn) Protocols available..............................155 ASCII protocol...................................158 Xmodem...........................................159 Xmodem CRC.......................................159 Relaxed Xmodem...................................159 1k-Xmodem........................................159 Ymodem Batch.....................................159 Ymodem-G.........................................160 External protocols...............................161 Downloading a File (PgDn)..........................164 The Download Window..............................165 ASCII............................................165 Xmodem, Xmodem CRC, Xmodem Relaxed and Xmodem-1k/G...............166 Ymodem and Ymodem/G..............................167 Scroll Back (UpArrow)..............................167 Capture to Disk (Ctrl-Home)........................169 Sending a BREAK signal (Ctrl-End)..................171 Backspace <-> DEL Toggle (Alt-1)...................172 EGA/VGA Screen Modes (Alt-2 thru Alt-6)............173 Hi Bit Stripping Toggle (Alt-8)....................173 Copying to the Printer (Ctrl-PrtSc)................174 Logging activity to a File (Alt-0).................175 Host Mode (Alt-5)..................................178 Host Setup.......................................179 External Files Required..........................179 Files created by the Host........................180 Optional Files...................................180 Logging on Locally...............................181 Starting the Host while ONLINE...................181 Sysop Commands while the Host is active..........181 Host Functions.......................................182 F File List.....................................183 U Upload........................................183 D Download......................................184 R Reading Messages..............................184 E Entering a Message............................185 Packing the Message Base.....................186 F2 CHAT mode....................................187 O Open Script...................................187 S Shell to DOS..................................190 The Qmodem Script Language an Introduction......................................191 What is a script?....................................191 Physical vs. Logical Screen..........................192 Input and Output Commands............................192 Variable Handling....................................192 Running Scripts......................................193 Script Commands......................................193 SCRIPT LANGUAGE REFERENCE................................193 Different types of Scripts...........................193 How to create and name a Script file.................194 Using an Editor..................................194 Starting a Script....................................195 /S= command line switch..............................195 The explicit Alt-F...................................195 Linked-Script........................................195 Stopping a Script....................................195 Debugging a Script...................................195 Special characters in Scripts........................200 Definitions and Parameters...........................202 Labels...........................................202 Pre-defined String variables.....................203 Pre-defined System variables.....................204 Connect Information variables....................206 Script Commands......................................209 General Coding Information.......................209 Scripts Command Reference............................211 ATWRITE..........................................212 ASSIGN...........................................213 BEEP.............................................213 BOX..............................................214 BREAK............................................214 CAPTURE..........................................215 CHDIR............................................215 CLOSEFILE........................................216 CLRSCR...........................................216 COLOR............................................217 COLORBG..........................................217 COLORFG..........................................218 DEBUG............................................219 DECR.............................................219 DELAY............................................219 DIAL.............................................220 DISPLAY..........................................221 DISPLAYLN........................................222 DOS..............................................222 DOWNLOAD.........................................223 DOWNLD...........................................224 DRIVE............................................224 EGA..............................................225 EXIST............................................225 EXIT.............................................226 FKEY.............................................226 FLUSH............................................227 GET..............................................227 GETR.............................................228 GETN.............................................228 GETNR............................................229 GETSCR...........................................230 GETX.............................................231 GOSUB............................................232 GOTO.............................................232 GOTOXY...........................................233 GRAPHICS.........................................233 HANGUP...........................................233 IF...............................................234 INCR.............................................235 INKEY............................................236 LOADFON..........................................236 LOADKEY..........................................237 LOG..............................................237 NOTE.............................................238 OPENFILE.........................................238 PAUSE............................................239 POP..............................................240 PORT.............................................241 PUSH.............................................242 PUTSCR...........................................242 READFILE.........................................243 RETURN...........................................243 SCRIPT...........................................244 SEND.............................................245 SETCOMM..........................................245 STAMP............................................246 STRING...........................................247 SYSTEM...........................................247 TIMEOUT..........................................248 TURNOFF..........................................248 TURNON...........................................248 UPLOAD...........................................249 UPLD.............................................251 WAITFOR..........................................251 WAITUNTIL........................................252 WHEN.............................................253 WINDOW...........................................254 WRITE............................................254 WRITELN..........................................255 WRITEFILE........................................256 Error Messages.......................................257 Appendix A - Common Questions and Answers License ______________________________________________________________________ Qmodem is not, and has never been in the Public Domain. Qmodem is not free. Non-registered users are granted a limited, 90-day license to Qmodem to determine whether or not the program meets their needs. Continued use of Qmodem beyond the 90-day evaluation time period requires registration of the program. Use of non-registered copies of Qmodem beyond the original evaluation period is strictly prohibited. No one may modify Qmodem for any reason, in any way, including but not limited to, decompiling-compiling, patching, disassembling, or reverse engineering the program. These restrictions also apply to all Qmodem screen displays such as the opening screen, help screen, and all other proprietary program output. Only 'FORBIN APPROVED' patches may be applied to the Qmodem program(s). Qmodem may be copied and distributed to others, subject to the above restrictions and the following: Qmodem must be copied in unmodified form, including the file containing this license information. Complete Qmodem documentation and Online Help must be included. No copying fee of any type may be assessed other than basic charges for the cost of the copying medium. Qmodem may not be distributed with any other software or hardware product(s) without the express written permission of The Forbin Project, Inc. Sysops (bulletin board SYStem OPerators) may make Qmodem available for downloading by their users as long as all above conditions are met. If problems are experienced due to the combined sizes of all Qmodem distribution files, the QMODEM documentation must be bundled with the QMODEM.EXE file to insure that the user gets it. Commercial Distributors of Public Domain, ShareWare, or User-Supported software may distribute Qmodem subject to the above conditions only after obtaining specific written permission from the Forbin Project, Inc and filling out a registration form for upgrade notifications. This condition supersedes any and all previous agreements. No blanket authorization has been issued by the Forbin Project, Inc., for commercial distribution of its products. Version 4.0 i Ordering Information ______________________________________________________________________ When you register your copy of Qmodem, you are granted a license to use the program as often as you wish. There are several advantages to registering your copy of Qmodem: 1. The Forbin Project, Inc. has 6 Bulletin Board Systems (BBS) in house for registered users. As soon as your registration is received, you will receive 1 year of support at no additional charge on these BBS's. After the first year, you may renew your subscription to the Forbin Project BBS. Subscription renewals also include access to all Qmodem updates released during that year on the BBS. 2. Telephone support, also for a one-year period following your registration date. No problem is too big or too small for us to tackle, but you must be a registered user to get this kind of support. 3. We run a "Round Table" (special interest group) on the General Electric GEnie system. Now we are a local phone call away from 99% of you! 4. Automatic notification of upcoming major new releases or enhancements through the mail and on the Forbin Project BBS. There are two methods for registering Qmodem: 1. Send a completed Registration form and a check for $30. We will assume that you have already obtained the program and documentation elsewhere. The $30 registration fee does not entitle you to diskettes or printed manuals. For an additional $15 ($45 total), you will receive the latest version of Qmodem, printed documentation, and utilities on diskettes. 2. If you have a valid Visa or Mastercard, we also accept phone-in orders. Call us during normal business hours at (319) 232-4516. If you are unsure and wish to get an evaluation disk set, you can send $15 and receive the latest version of Qmodem, documentation, and utilities. The $15 "Trial Disk" fee does not include any of the registration benefits described earlier. Non U.S. residents: please send checks or money orders drawn on U.S. Banks or in U.S. Funds if at all possible. Payments in foreign currency must include a $10 U.S. equivalent surcharge to cover currency exchange handling and foreign shipment charges. VISA or MasterCard are also acceptable. All foreign orders are subject to current U.S. foreign trade and technology exchange restrictions. ii Qmodem Operations Manual INVOICE # 88-270945 Remit To: The Forbin Project, Inc. Post Office Box 702 Cedar Falls, IA 50613 Qty. Description Amount ____ Qmodem Evaluation Disk set $15.00 ea _________ ____ Qmodem Printed Manual $15.00 ea _________ ____ Qmodem (single user) License $30.00 ea _________ ____ Qmodem License, Disk set & $60.00 ea _________ Printed Manual Less Discount _________ Subtotal _________ (Iowa residents add 4% sales tax Tax _________ if you are receiving a diskette) Total _________ Payment: Check [ ] MasterCard [ ] Visa [ ] PO [ ] ________________ Name: ________________________________________________________ Company: ________________________________________________________ Address: ________________________________________________________ ________________________________________________________ Work Phone: (____) ____________ Home Phone: (____) ___________ Card #: ___________________________________ Exp. Date: _______ Signature of Cardholder: ________________________________________ Version 4.0 iii Site License Information ______________________________________________________________________ If you plan on using Qmodem in a corporation, government office, or for any business purpose whatsoever, registration is mandatory and the 90 day limited license is strictly enforced. Quantity discounts are available under a Site License agreement, described below: One MASTER copy of Qmodem and its documentation will be supplied on disk. The site license customer is responsible for printing the documentation and copying the disks for distribution. Archival backups of the MASTER copy are not counted toward the total copies of the license. For all site licenses, the customer must appoint a single contact person with whom all Qmodem related dealings will take place. Should a problem occur, that person -- and that person alone -- must call to report the problem and arrange for its resolution. All Qmodem program updates will be forwarded to the contact person. When filling out the order form, please use the contact person's name to prevent any later misunderstandings. Site license discount rates are as follows: Total copies Discount 11 - 20 5% 21 - 30 10% 31 - 40 15% 41 - 50 20% 51 - 100 25% 101 - 200 30% 201 - 300 35% 301 - 500 40% 501+ 50% NOTE: All prices and discounts are subject to change without notice. Discounts are not cumulative; they apply to separate orders only. NOTE: Purchase Orders less than $100 must be pre-paid. iv Qmodem Operations Manual System Requirements ______________________________________________________________________ Qmodem requires an IBM PC,XT,AT,PS/2 or IBM compatible computer with at least 384K RAM, a Color Graphics or Monochrome adapter and monitor, and a serial port and modem. Listed are some of the hardware configurations on which Qmodem has been tested. This list is by no means all-inclusive, but these have been tested and are known to work properly. Computers: IBM PC/XT/AT/PS/2 or close compatible Tandy 1000,1200,3000,5000 AT&T 6300 & 6300+ Compaq (all models including 386) PCs Limited (all models) Video Cards: IBM Monochrome or compatible Hercules Mono or Color Graphics IBM Color Graphics or compatible IBM EGA or compatible with 128K or more. IBM VGA or compatible. Video-7 EGA/VGA. Genoa EGA/VGA. Paradise EGA/VGA. Orchid VGA. Serial Port: IBM Serial/Parallel adapter. IBM Dual Async Adapter/A (PS/2). Most any clone card with jumpers to be compatible with COM1: and/or COM2: compatibility. Modems: Hayes and compatible. USRobotics (all models, including HST). Multi-Tech (all models). Version 4.0 v Warranty (or lack of it) ______________________________________________________________________ The Forbin Project, Inc. makes no warranty of any kind, express or implied, including without limitation, any warranties of merchantability and/or fitness for a particular purpose. The Forbin Project, Inc. shall not be liable for any damages, whether direct, indirect, special or consequential arising from a failure of this program to operate in the manner desired by the user. The Forbin Project, Inc. shall not be liable for any damage to data or property which may be caused directly or indirectly by the use of this program. IN NO EVENT WILL THE FORBIN PROJECT, INC. BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING ANY LOST PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF YOUR USE OR INABILITY TO USE THE PROGRAM, OR FOR ANY CLAIM BY ANY OTHER PARTY. vi Qmodem Operations Manual Definitions ______________________________________________________________________ Throughout the documentation, you may run into technical terms or everyday computer terminology with which you are not familiar. Following are some text examples you may come across: [ENTER] This represents the Return or Enter key on the keyboard. If you see this in the text, press the Enter key rather than typing in the string. ESC or [ESC] This refers to the Esc key on the keyboard. Alt-[character] Alt- is always followed by a character which means press and hold the Alt Key and hit the following letter. Alt-A means hold the Alt key down and press 'A'. Ctrl-[character] Is executed the same way the Alt- is handled. You press and hold the Ctrl key and then press the following letter. Ctrl key combinations may also be specified by the ^ (carat) as in ^T (Ctrl-T) or ^V (Ctrl-V). .. (ellipsis) Means "and everything in between". For example, A..Z means all letters A through Z. The following bars represent an image on the screen. ╔════════════════════════════════════════════════╗ Sample text displayed on the screen. ╚════════════════════════════════════════════════╝ Version 4.0 1 What's New in Qmodem 4.0 ______________________________________________________________________ Qmodem SST 4.0 major enhancements include: o In addition to the overlay version (.EXE & .OVR files) of the program, Qmodem is also available as a single executable (.EXE) file. The single .EXE version of Qmodem will outperform the overlaid version (if you have sufficient memory). The single .EXE version is only available on the Forbin Project BBS. o The overlaid version will make use of Expanded Memory (EMS) if available. By storing the OVR file in EMS, significant speed improvements are realized. This is totally transparent to the user. o Improved overall performance. Qmodem automatically detects the PC's microprocessor type (IE., 8088, 80286, 80386) and optimizes itself accordingly. o Exhaustive "Context-Sensitive" Help is available from all Windows and command prompts. o Internal Host Mode, complete with password security, messaging and file transfer capabilities, as well as security callback features. o Script "Quick-Learn" mode. Creating a customized logon script, for example, is as simple as pressing Alt-Q. o Integrated Text Editor, configurable by the user. Function keys may be defined to match your favorite editor's assignments. o Full compatibility with Omen Technology's communication protocols, including Ymodem and Ymodem-G in batch mode. o The Dialing Directory can be sorted, printed or searched easily. Entries may be tagged and untagged, and the current entry is highlighted with a screen-wide cursor. Creating a list of numbers to be dialed has never been easier! All 200 entries can now be 'tagged' and the Redialer will cycle through all of them. Entries can have their own attached NOTE files. Using the internal editor makes it easy to maintain these Notes. Even the new Find & Again commands will search the attached notes. o The QINSTALL configuration program has been totally integrated into Qmodem. Pull-down, pop-up menus allow all the options to be changed quickly. Improvements were made to some of the configuration options. For example, memory is allocated based on the purpose it will serve: scroll-back memory is allocated as a number of scroll-back lines rather than as a memory value. 2 Qmodem Operations Manual Screen colors may be totally customized, or predefined color combinations may be used. o Intelligent "fail-safe" memory allocation logic. Over-allocation of memory to scroll-back buffers, Download buffers, Script variables, or the Internal Editor is detected and "best-fit" values are reassigned to insure proper program operation. In addition, memory saving code is used to manage the scroll-back buffer. o "Shelling" to DOS now takes advantage of the unused portions of the allocated memory just described. Even with maximum values in memory allocation, the Shell is able to operate. o Significant improvements in the Script language, including much faster script execution speed, ability to read and write ASCII files, and much more flexible script variable allocation. While testing a script, an error will invoke the built in editor and position the cursor at the offending line. o A newly structured general help screen, redesigned configuration windows and exploding shadowed windows. File transfer windows now feature a dynamic bar graph display which tracks the transfer in progress for all uploads and batch downloads. o Many of the status/field-delimiting characters are now definable by the user. Some examples are: Status-line date and time separator characters, music and bells indicators, the Tag and Attached-notes indicators in the Phone book, just to name a few. o Support for the 101-key enhanced keyboard, including the new F11 and F12 keys. Operating Environments ______________________________________________________________________ Four multi-tasking environments are supported by Qmodem. TopView from IBM, DESQview from QuarterDeck Systems, TaskView/OmniView from Sunny Hill Software and Windows/386 from Microsoft. TopView, DESQview and Windows/386 allow Qmodem to run in a window and without requiring the whole screen. TaskView takes a slightly different approach and gives Qmodem an entire screen when the partition is selected. All four of these multi-tasking programs let you be more productive by running other software at the same time as Qmodem. TIP: The Utilities Disk contains special configuration files for DESQview (QMODEM.DVP) and Windows/386 (QMODEM.PIF). Version 4.0 3 Qmodem may not operate properly when other background software is running. By other background software, we mean programs that are loaded in the CONFIG.SYS, or a Batch file and remain in memory. Certain screen clock programs, for example, are known to interfere severely with serial port operations. If you experience loss of incoming data or other unpredictable problems, it is possible that one of these programs is interfering with Qmodem. Remove these programs or device drivers from the AUTOEXEC.BAT or CONFIG.SYS file one at a time until you find the offender. Another method is to start DOS without any resident programs or device drivers and add them back in, one at a time, until the culprit is identified. Most expanded memory drivers, mouse drivers, and hard- disk partitioning software drivers do not interfere with Qmodem operation. One program which is known to interfere seriously with serial port operations is the clock driver supplied with some early memory and multi-function boards. Conflicts with Qmodem may not be caused by a single program, but by a combination of programs, which, taken singly, cause no problems. Therefore, if you suspect some conflict, you should boot your system with only absolutely necessary device drivers and resident programs (IE., a partitioned disk device driver). Backup your diskettes! ______________________________________________________________________ The first thing you should do is back up your Qmodem distribution disks. Always backup your disks! I can't stress this enough! Please refer to your DOS manual if you are not sure how to backup your disks. Floppy Disk Installation ______________________________________________________________________ Qmodem diskettes have come pre-installed and you only need to make backups. Be aware that Qmodem does require one of the following floppy drive setups: 2 - 360K floppy drives This allows you to use one of the floppy drives for downloading. The drive with the QMODEM.OVR file must never be removed during operation. 4 Qmodem Operations Manual 1 - 720K floppy & 1 - 360K floppy This allows all of the Qmodem files to remain on the 720K drive and allows the 360K to act as the data disk for downloading and uploading. You should be able to split the files as if you have 2 360K drives and use the 720K as your data disk. Again, the floppy with the QMODEM.OVR file must never be removed during operation. Copy all of the files from the distribution diskette to a working diskette. The recommended files on each diskette are as follows: Disk #1 QMODEM.OVR (overlay for main program) QMODEM.CNF (configuration file) QMODEM.FON (Alt-D phone book) QMODEM.PRE (phone book prefixes) QMODEM.KEY (function key text) QM.BAT (startup BATCH file) COMMAND.COM (to allow shelling to DOS) Disk #2 QMODEM.HLP (online help) QMODEM.EXE (main program) *.SCR (optional script files) NOTE: When using a single 720K or 1.2mb drive, disks #1 and #2 are combined on the single floppy. Starting Qmodem in a Floppy Setup ______________________________________________________________________ Follow these directions: 1. Place a bootable DOS disk in drive A: and press Ctrl-Alt-Del. 2. Place disk #1 in drive A: and disk #2 in drive B:. 3. Type QM and press [ENTER] at the A> prompt. 4. When the "Terminal mode" message appears on the screen, you can remove disk #2 from the B: drive and use it as a SCRATCH disk for uploads and download. NOTE: Before running the Alt-N Setup or accessing the Online Help, make sure disk #2 is back in the B: drive. Version 4.0 5 The QM.BAT file should look something like this: PATH A:\;B:\ B:QMODEM The first line allows Qmodem to search both drives for files it may need to allocate. The second line tells DOS to load Qmodem from the B: drive and remain logged to the A: drive. This is important, because you may want to remove the B: disk after Qmodem has loaded. Hard Disk Installation ______________________________________________________________________ When installing Qmodem on a harddisk, all of the floppy disks should be copied into the \QMODEM subdirectory. You should also modify your AUTOEXEC.BAT file as follows: 1. Add the \QMODEM subdirectory to your existing PATH= statement. 2. Add a SET QMODEM=C:\QMODEM (or the name of the subdirectory you create). This is an environment variable that Qmodem checks when it is loaded. If it finds one, then it will also search the defined subdirectory for any of the Qmodem specific files it requires. Making these two adjustments allows Qmodem to be started from any subdirectory without needing a special BAT file. You could start Qmodem from your word-processor directory simply by typing QMODEM at the DOS prompt! Subdirectory Structure ______________________________________________________________________ It is said that a picture is worth a thousand words... Here is a picture of one possible Qmodem subdirectory setup on a hard disk: C:\───QMODEM───┬─DOWNLOAD ├─HOSTDIR └─SCRIPTS The QMODEM\DOWNLOAD directory will be used to store all uploaded and downloaded file. A separate directory is optional, but having it will make it easier for you to see what you have transferred. The QMODEM\HOSTDIR is similar to the QMODEM\DOWNLOAD directory, but is used by the internal Host mode of Qmodem. Callers to the HOST will be restricted to this directory. 6 Qmodem Operations Manual The QMODEM\SCRIPTS directory is used for script file storage. Keeping scripts in a dedicated directory makes script maintenance easier. Copy all .SCR files from the distribution disks to this directory. Getting Help when you need it ______________________________________________________________________ Qmodem features "context-sensitive" help. As the name suggests, relevant help information is available for any command as you execute it, just by pressing the Help Key. Check the lower-right corner of a command's window; if the words "F1 Help" are displayed, then pressing the [F1] function key will open a special help window explaining the command and its various options. For example: ╔════════════════════════════════════════════════╗ ╒══ Change Log Drive ══╕ │ Logged Drive is : C │ │ Enter new Drive : _ │ ╘══════════════F1 Help═╛ ╚════════════════════════════════════════════════╝ The online help is not all-inclusive, which is why you are reading this paragraph. Although the context-sensitive help is as detailed as possible, it still is no substitute for the documentation. Summary command help is available from the HOME window by pressing the [F1] key, followed by the desired command key combination. When the [F1] key is pressed, the status line changes to the following display: ╔════════════════════════════════════════════════╗ ▒▒▒▒▒▒▒ Press the key combination you need help with -or- [ESC] to Exit ▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ For example, to get summary help for the Translate Table command (Alt-A), press Alt-A, and the Translate Table summary help window will be displayed. If you pressed [F1] by mistake, press [ESC] to return to the previous Status Line. NOTE: Pressing [ESC] will exit 99.9% of all windows and Qmodem functions without making any changes. Version 4.0 7 Starting Qmodem for the First Time ______________________________________________________________________ Qmodem is started by typing "Qmodem [ENTER]" from the DOS prompt: A>QMODEM [ENTER] As Qmodem starts, it displays its logo on the screen: ╔════════════════════════════════════════════════╗ ──────────────────────────────────────────────────────────────────────────────── ─────█▀▀▀▀▀▀▀▀▀▀▀▀▀▀█─────────────────────────────────────────────────────────── ─────█ ▄▄▄▄▄▄▄▄▄▄ █────────────────────────────▄▄▄──────────────────────────── ─────█ █────────█ █────────────────────────────█ █──────────────────────────── ─────█ █────────█ █────────────────────────────█ █──────────────────────────── ─────█ █────────█ █--▄▄▄▄▄▄▄▄▄▄▄--▄▄▄▄▄▄▄--▄▄▄▄█ █--▄▄▄▄▄▄▄--▄▄▄▄▄▄▄▄▄▄▄────── ─────█ █────────█ █--█ ▄▄▄ ▄▄▄ █--█ ▄▄▄ █--█ ▄▄▄ █--█ ▄▄▄ █--█ ▄▄▄ ▄▄▄ █────── ─────█ █────────█ █--█ █-█ █-█ █--█ █-█ █--█ █-█ █--█ █-█ █--█ █-█ █-█ █────── ─────█ █────────█ █--█ █-█ █-█ █--█ █-█ █--█ █-█ █--█ ▀▀▀ █--█ █-█ █-█ █────── ─────█ █────────█ █--█ █-█ █-█ █--█ █-█ █--█ █-█ █--█ █▀▀▀▀--█ █-█ █-█ █────── ─────█ ▀▀▀▀▀▀▀▀▀▀ ▀--█ █-█ █-█ █--█ █▄█ █--█ █▄█ █--█ █▄▄▄▄--█ █-█ █-█ █────── ─────█▄▄▄▄▄▄▄▄▄▄▄ █▀▀█-█▄█-█▄█-█▄█--█▄▄▄▄▄█--█▄▄▄▄▄█--█▄▄▄▄▄█--█▄█-█▄█-█▄█────── ──────────────────█▄▄█────────────────────────────────────────────────────────── ──────────────────────────────────────────────────────────────────────────────── ────────────▄▄▄▄▄▄▄▄--▄▄▄▄▄▄▄▄--▄▄▄▄▄▄▄▄▄───────▄▄▄--▄▄▄────▄▄▄▄▄▄▄▄──────────── ────────────█ ▄▄▄▄▄█--█ ▄▄▄▄▄█--█▄▄▄ ▄▄▄█───────█ █--█ █────█ ▄▄▄▄ █──────────── ────────────█ █───────█ █──────────█ █──────────█ █--█ █────█ █--█ █──────────── ────────────█ █▄▄▄▄▄--█ █▄▄▄▄▄─────█ █──────────█ █--█ █────█ █--█ █──────────── ────────────█▄▄▄▄▄ █--█▄▄▄▄▄ █─────█ █──────────█ █▄▄█ █────█ █--█ █──────────── ─────────────────█ █───────█ █─────█ █──────────█▄▄▄▄▄ █────█ █--█ █──────────── ────────────▄▄▄▄▄█ █--▄▄▄▄▄█ █─────█ █───────────────█ █────█ █▄▄█ █──────────── ────────────█▄▄▄▄▄▄█--█▄▄▄▄▄▄█─────█▄█───────────────█▄█-██-█▄▄▄▄▄▄█──────────── ──────────────────────────────────────────────────────────────────────────────── ──────────────────────────────────────────────────────────────────────────────── ──────────── »» World Class Communications at a Shareware Price! «« ────────── ──────────────────────────────────────────────────────────────────────────────── ╚════════════════════════════════════════════════╝ Depending on whether or not the copy of Qmodem is registered, this will remain on the screen for up to 3 seconds. Registered version will begin to load immediately after this is displayed while non- registered version include a small time delay. (nudge, nudge) 8 Qmodem Operations Manual If this is a first-time installation, the following screen will appear after the opening has disappeared: ╔════════════════════════════════════════════════╗ QMODEM INSTALLATION PART 1 The file QMODEM.CNF was not found in the current directory or the directory pointed to by the Environment variable "QMODEM=", so it is assumed this is a new installation. A few questions will be asked to determine how Qmodem should be setup for you. Please follow the directions and this will only take a few minutes. _______________________________________________________________________________ Display adapter detected : EGA Do you want to use BIOS screen writes ? [Y/N] Do you have a Color monitor connected ? [Y/N] ╚════════════════════════════════════════════════╝ Because the QMODEM.CNF configuration file was not found, Qmodem requires information about your display hardware. In the previous screen, an EGA card was detected. Setup will then ask if you want Qmodem to use BIOS screen access (very slow, but clean) or not. If you answer No, Qmodem writes directly to video memory for lightning fast screen displays. BIOS screen writing is much slower because every character displayed goes through the BIOS. This is the IBM-approved way of doing things (figures, don't it?). The next question asks if you have a color monitor attached to your video card. Monochrome displays may be attached to color adapters. If this is your case, reply NO to this question. Setup questions are based on the video adapter in your system. The previous example applied to EGA/VGA/MCGA adapters. If your system is Version 4.0 9 equipped with a CGA or Monochrome display, the prompts would have changed: ╔════════════════════════════════════════════════╗ Display adapter detected : CGA Press any key to test for video snow > _ Did your screen look fuzzy ? [Y/N] _ Do you want to use BIOS screen writes ? [Y/N] _ Do you have a Color monitor connected ? [Y/N] _ ╚════════════════════════════════════════════════╝ Early IBM CGA and "cheap" clones suffer from "snow" and "flicker" when display memory is accessed. When you to press a key, Qmodem will attempt to generate the snow or flicker on your display. If irregular or fuzzy patterns or dots appeared on your screen, reply Y to the next question. The next two questions are the same as in the EGA example. The Monochrome card and monitor is a much simpler setup. The only question asked is if you want to use BIOS screen writes: ╔════════════════════════════════════════════════╗ Display adapter detected : Monochrome Do you want to use BIOS screen writes ? [Y/N] _ ╚════════════════════════════════════════════════╝ Your answers to these questions enable Qmodem to configure its initial operating display parameters based on your video hardware and particular operating environment. NOTE: If this is an upgrade to a previous release, Qmodem 4.0 will read the existing QMODEM.CNF and skip these questions. Configuration ______________________________________________________________________ Configuring Qmodem is simple, whether you are installing Qmodem for the first time or upgrading from a previous release. Seasoned Qmodem veterans should read the section on Menu Navigation and Upgrading from a previous release. First time users should go through the Installation Section of the manual and ignore the Upgrade section. 10 Qmodem Operations Manual Menu Navigation ______________________________________________________________________ The Alt-N Setup Screen will be automatically displayed the first time Qmodem is started: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files Options Exit │ ╘═══════════════════════════════════════════════════════════════════════F1 Help╛ QMODEM INSTALLATION PART 2 This is the Qmodem 4.0 "Alt-N Setup Menu". With it, you can customize almost every part of Qmodem. Go through all of the options now to finish the installation procedure. When you are through, select Exit/Save to write out the new configuration file. Press ENTER to Edit the selected option or open a SubMenu. Press ESC to abort the changes made or close the SubMenu. ╔═══════════════════╗ ║ Option A * ║ ┌─── Selections that are followed by the character ║ Option B ───────┘ have SubMenus below them. ║ ╔═════════════════════╗ ║ ║ Sub Option B1 * ──── Selections that are followed by the * character ╚═║ Sub Option B2 ║ take effect immediately. To save the change, you ║ Sub Option Other * ║ still have to use Exit/Save from the top Menu. ╚═════════════════════╝ ┌─ The Status Line will always give you help on │ the option you are changing. │ ░░░░░░░░░░░░░░░░░░░░░░ Change the way Qmodem looks to you ░░░░░░░░░░░░░░░░░░░░░░ ╚════════════════════════════════════════════════╝ The top window is the Alt-N Setup window, which we will refer to as "Setup" from here on. Since this is a new installation, it is invoked automatically. The accompanying text explains how to navigate through the Setup Menus. NOTE: This text is only shown for first-time installation. Subsequent calls to Setup only display the Menu Window. Items may be selected with two different methods: 1. By pressing the highlighted letter in the desired menu entry, or 2. By moving the selection bar to the desired item and pressing [ENTER]. To move the selection bar, use the cursor keys. Version 4.0 11 Menu entries followed by a down-pointing arrow "" have one or more additional menu levels. When such an entry is selected, another menu will be displayed from which additional entries or parameters are configured. Since all Main Setup Window entries have associated menus, the arrows were omitted. Changes made to entries followed by an asterisk "*" go into effect immediately. These will be noted as we proceed through the Setup instructions. Some menu entries may have both an asterisk and a down-pointing arrow; which means that changes to entries in lower-level menus go into effect immediately. As you can see from the main Setup window, changes made to entries in the Colors, Dirs, Host and Protocols menus will take effect immediately. While in Setup, the status line always displays a brief description of the currently selected item. If additional information is needed, press the [F1] key for detailed online help. While changing to an item, pressing [ESC] restores its original value. To save the change, press [ENTER]. Changes to the Setup are not saved automatically; when done you must use the Exit/Save Top Menu Option to save all changes in the QMODEM.CNF file. First Time Setup ______________________________________________________________________ Now that you can navigate through Setup menus, let's start with the various setup tasks from left to right. Colors is first... 12 Qmodem Operations Manual Alt-N/C Colors ______________________________________________________________________ The Colors Setup option is used to configure Qmodem screen colors. You may select one of 5 pre-defined color combinations, or customize the colors to your liking. ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files * Options Exit │ ╘╒═══════════════════╕══════════════════════════════════════════════════F1 Help╛ │ Custom colors │ │ Blue shades │ │ Purple shades │ │ Red shades │ │ Monochrome shades │ │ LCD Laptop shades │ ╘════════════F1 Help╛ ╚════════════════════════════════════════════════╝ The last five options are the predefined color combinations mentioned earlier. The last two entries are intended for standard monochrome displays and Laptop Liquid Crystal (LCD) displays which can only display shades of Gray. NOTE: Colors are a cosmetic feature and have no effect on Qmodem's operation. First-time users should select one of the predefined color combinations and concentrate on other sections of the Qmodem setup. Colors may be customized easily after all other operational parameters. Version 4.0 13 Alt-N/C/C Custom Colors ______________________________________________________________________ Selecting the Custom Colors options yields the following menu: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files Options Exit │ ╘╒═══════════════════╕══════════════════════════════════════════════════F1 Help╛ │ Custom colors │ │ ╒════════════════════════════╕ │ │ A - Pulldown normal text │ │ │ B - Pulldown first letter │ │ │ C - Pulldown selection bar │ │ │ D - Pulldown window border │ ╘═│ E - Pulldown edit field │ │ F - Window border │ │ G - Window primary text │ │ H - Window secondary text │ │ I - Window Scroll Bar │ │ J - Screen border │ │ K - Screen text │ │ L - Information text │ │ M - Status line │ │ N - Online Help border │ │ O - Online Help text │ │ P - Editor primary text │ │ Q - Editor marked text │ │ R - Editor window border │ ╘═════════════════════F1 Help╛ ╚════════════════════════════════════════════════╝ The 18 entries in the custom colors menu correspond to the following areas and elements of the Qmodem screen whose colors can be individually customized: A. Pulldown normal text (Alt-N/C/C/A) The color of entries that can be selected in pulldown menus. B. Pulldown first letter (Alt-N/C/C/B) The color of the Entry Selection Character, which should stand out from the normal text so it can be identified easily. 14 Qmodem Operations Manual C. Pulldown selection bar (Alt-N/C/C/C) The color of selected text (IE., the text under the menu selection bar). This should also contrast with the normal text color. D. Pulldown window border (Alt-N/C/C/D) The frame (or border) color of all pulldown menu windows. E. Pulldown edit field (Alt-N/C/C/E) The color of variable menu text while it is being edited. When pressing [ENTER] to select the option, the text will change from the scrollbar color to this color to indicate that edit mode is active. Pressing [ENTER] (accept the change) or [ESC] (restore the original value) will change the text color back to that of the scrollbar. F. Window border (Alt-N/C/C/F) The frame color of the windows displayed for most Alt- key command. G. Window primary text (Alt-N/C/C/G) H. Window secondary text (Alt-N/C/C/H) The colors of the two types of text usually displayed in Alt-key command windows, for example fixed labels and variable text. The two should share the same background color, or unusual-looking window displays are likely to result. I. Window Scroll Bar (Alt-N/C/C/I) The color of the Phone Directory (Alt-D) Scrollbar cursor. This should contrast with the color of the window text defined above. J. Screen border (Alt-N/C/C/J) The color of the 3/4" CRT edge which surrounds the display area. The border color can be set on CGA displays, but may yield questionable results on EGA and VGA displays (IE., thin, unevenly-spaced lines). Monochrome displays do not allow different screen border shades. Version 4.0 15 NOTE: Border color is not an "officially-supported" EGA or VGA feature. Thus, questionable results with these displays are the result of hardware limitation, NOT a Qmodem bug. K. Screen text (Alt-N/C/C/K) The color of standard screen text displayed while in terminal mode. The majority of the text viewed during an online session will be in this color. TIP: Text color may change while online under ANSI or VT100 emulation mode. To restore the default color, press Alt-C to clear the screen. L. Information text (Alt-N/C/C/L) The color of Qmodem messages displayed while in terminal mode to notify you of some important event or condition. This text was not received from the remote system. It should be easily distinguishable from normal screen text. M. Status line (Alt-N/C/C/M) The color of the Qmodem Status line, displayed at the bottom of the screen. Because of the critical importance of status line information, it should also be distinguishable from normal screen text. N. Online Help border (Alt-N/C/C/N) O. Online Help text (Alt-N/C/C/O) The colors used in online help windows, displayed when the [F1] key is pressed. Since keywords within the help text are displayed in the window border color, the same background color should be used for both. P. Editor primary text (Alt-N/C/C/P) Q. Editor marked text (Alt-N/C/C/Q) R. Editor window border (Alt-N/C/C/R) The colors of the Qmodem Internal Editor's primary text, marked text, and window frame. "Marked text" is text which has been selected for subsequent action (IE, block move, cut/paste etc...). Editor status information at the top of the editor window is also displayed in the Marked Text color. 16 Qmodem Operations Manual NOTE: Embedded Control characters are normally displayed in the Marked Text color. When control characters themselves are marked, they are displayed in the Primary color. Customization Window ______________________________________________________________________ When one of the 18 screen elements is selected, the Qmodem color selection screen is displayed: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files Options Exit │ ╘╒═══════════════════╕══════════════╒═════════════ Sample Screen ══════════════╕ │ Custom colors │ │ Option 1 Option 2 Option 3 │ │ ╒╒═══Pulldown normal text═══╕╕ │ ╒════════════════════╕ │ │ ││ ││ │ │Field in Edit░░░░░░░│ ╒ Help Window ╕ │ │ ││ ■ ■ ■ ■ ■ ■ ■ ■ ││ │ │Not in Edit░░░░░░░░░│ │ Text color │ │ │ ││ ■ ■ ■ ■ ■ ■ ■ ■ ││ │ ╘════════════════════╛ ╘═════════════╛ │ │ ││ ■ ■ ■ ■ ■ ■ ■ ■ ││ │ │ ╘═││ ■ ■ ■ ■ ■ ■ ■ ■ ││ │ ╒════ Frame Color ═════╕ │ ││┌───┐■ ■ ■ ■ ■ ■ ■ ││ │AT │Primary window text │ │ │││ ■ │■ ■ ■ ■ ■ ■ ■ ││ │OK │Secondary text │ │ ││└───┘■ ■ ■ ■ ■ ■ ■ ││ │ │Scroll Bar text │ │ ││ ■ ■ ■ ■ ■ ■ ■ ■ ││ │ │ │ │ ││ ■ ■ ■ ■ ■ ■ ■ ■ ││ │ ╘══════════════════════╛ │ ││ ■ ■ ■ ■ ■ ■ ■ ■ ││ │ │ ││ ■ ■ ■ ■ ■ ■ ■ ■ ││ │ ╒═══════ Full Screen Edit ═══════╕ │ ││ ■ ■ ■ ■ ■ ■ ■ ■ ││ │ │ Normal Text │ │ ││ ■ ■ ■ ■ ■ ■ ■ ■ ││ │ │ Marked Text │ │ ││ ■ ■ ■ ■ ■ ■ ■ ■ ││ │ ╘════════════════════════════════╛ │ ││ ■ ■ ■ ■ ■ ■ ■ ■ ││ │ │ ││ ■ ■ ■ ■ ■ ■ ■ ■ ││ │Information message text │ ││ ││ │░░░░░░░░░░░░░░░ Status Line ░░░░░░░░░░░░░░│ ╘╘══════════════════════════╛╛ ╘══════════════════════════════════════════╛ ╚════════════════════════════════════════════════╝ At the left of the screen is a color chart showing all possible foreground and background color combinations. To select a color, move the square color selector box with the arrow keys. The change is immediately reflected in the Qmodem mini-screen on the right side of the display. NOTE: In the example above, the Pulldown Normal Text is being modified. Version 4.0 17 Pressing [ESC] restores the item's original color. To confirm the color change, press [ENTER]. All color changes will take effect immediately. NOTE: Color changes must be saved explicitly via the Alt-N Exit/Save menu option. If the new color settings are not saved, the last color setup will be restored the next time Qmodem is started. Alt-N/M Modem ______________________________________________________________________ Modem-dependent settings affect the interaction between Qmodem, your computer, and your modem. If you use a 1200bps Hayes Smartmodem (or compatible unit) attached to the first communication port in your computer (COM1), most of Qmodem's default modem parameters are correct. However, the modem setup must be reviewed to insure that specific parameters are set properly. Selecting the Alt-N Modem option yields the following menu: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files Options Exit │ ╘════╒════════════════════════════╕═════════════════════════════════════F1 Help╛ │ Communication Parameters │ │ Modem Commands * │ │ Port Addresses │ ╘═════════════════════F1 Help╛ ╚════════════════════════════════════════════════╝ The Modem Menu features three selections: C. Communication Parameters (Alt-N/M/C) These hardware parameters control the operation of the communication port and its interaction with the modem. M. Modem Commands (Alt-N/M/M) Modem commands define the text of messages SENT TO the modem to cause a specific action (IE., dial, hang up), or RECEIVED FROM the modem to acknowledge a command (IE., OK, ERROR), or reflect a specific condition (IE., BUSY, CONNECT, NO CARRIER). 18 Qmodem Operations Manual P. Port Addresses (Alt-N/M/P) Port addresses are hardware-dependent values which define the computer's communications (COM) ports. Two COM ports (COM1 and COM2) are standard for most IBM PC, XT, AT, PS/2 and compatible machines (although only one may be available). Qmodem allows up to eight communication ports (COM1 through COM8). Alt-N/M/C Communications Parameters ______________________________________________________________________ When the Communication parameters option is selected, the following menu is displayed: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files Options Exit │ ╘════╒════════════════════════════╕═════════════════════════════════════F1 Help╛ │ Communication Parameters │ │ Mo╒═════════════════════════════════════════════════╕ │ Po│ A - Default baud rate 1200 │ ╘═══│ B - Default data bits 8 │ │ C - Default parity None │ │ D - Default stop bits 1 │ │ E - Command before baud change * ░░░░░░░░░░░░░░ │ │ F - Command after baud change * ░░░░░░░░░░░░░░ │ │ G - Cycle delay * 5 │ │ H - Timeout delay * 60 │ │ I - Modem command delay * 10 │ │ J - Serial port 1 │ ╘══════════════════════════════════════════F1 Help╛ ╚════════════════════════════════════════════════╝ A. Default Baud Rate (Alt-N/M/C/A) The Baud Rate is the speed at which the COM port operates; it should match the modem's speed. Supported speeds are 300, 1200, 2400, 4800, 9600, 19200 and 38400. The default baud rate is 1200. NOTE: With many error-correcting and high-speed modems, the COM speed can be set higher than the modem's nominal communications speed. For example, the USR Courier HST modem, rated at 9600 baud, supports a COM speed of 19200 baud. Consult your modem manual for additional information on supported COM speeds. Version 4.0 19 B. Default Data Bits (Alt-N/M/C/B) Characters transmitted over phone lines are made up of data bits. For communications which support text and program file transfers (IE., most PC-based BBS systems), 8 data bits are required. When communicating with mainframe or minicomputer-based systems, a value of 7 is often used, unless otherwise specified. The Qmodem data bits setting must match that of the software operating on the remote computer. C. Default Parity (Alt-N/M/C/C) Parity is used to insure the validity of the data being transmitted and received. Parity values are None, Odd, or Even. This value must match that used by the computer being called. Most BBS's use No Parity, the default value. D. Default Stop Bits (Alt-N/M/C/D) Stop bits are generated by the UART to isolate transmitted characters. The majority of computer systems require 1 stop bit, the default value. As with other parameters, this value must match the other computer's setting. E. Command Before Baud Change (Alt-N/M/C/E) F. Command After Baud Change (Alt-N/M/C/F) These two strings are sent to the modem before and after the serial port speed is changed. The default value is blank. Non- standard modems may require a different value. G. Cycle Delay (Alt-N/M/C/G) The Cycle Delay is the number of seconds Qmodem waits after an unsuccessful dial (IE., a BUSY signal) before trying the next number in the dialing queue (or the same number again). The default value is 45 seconds. H. Timeout Delay (Alt-N/M/C/H) The Timeout Delay is the number of seconds Qmodem waits for a connection after dialing a number. When this period has expired, Qmodem will instruct the modem to hang up. The default value is 60 seconds. 20 Qmodem Operations Manual TIP: Most modems feature an internal timeout delay. When dialing, the shortest delay will prevail. Make sure that your modem's internal timeout value is at least equal to the Qmodem setting. In Hayes and compatible modems, the command ATS7=60 will set the modem's internal delay to 60 seconds. Increasing the modem's own timeout value allows Qmodem total control over the dialing process. I. Modem Command delay (Alt-N/M/C/I) This is the delay, in milliseconds (1000 = 1 second) inserted between characters sent to the modem while it is OFFLINE. The default value is 0. Some high-speed modems may require a non- zero value if commands are not recognized, or if the modem does not return an OK acknowledgment. The most common symptoms are the modem's lack of an OK response when first initialized, or the modem's inability to dial. J. Serial Port (Alt-N/M/C/J) This is the port number (1-8) to which the modem is attached. The default is port 1. For port addresses higher than 2 be sure to configure the Base address and IRQ in the Alt-N/M/P menu. NOTE: The default Speed, Parity, Data bits and Stop bits values are not fixed. Defaults can be overridden in each dialing directory entry to match the settings of the remote computer. Version 4.0 21 Alt-N/M/M Modem Commands ______________________________________________________________________ When the Modem Commands option is selected, the following menu is displayed: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files Options Exit │ ╘════╒════════════════════════════╕═════════════════════════════════════F1 Help╛ │ Communication Parameters │ │ Modem Commands * │ │ Po╒════════════════════════════════════════════════════╕ ╘═══│ Initialization Command ATE1Q0X1V1S7=60^M░░░░░░░ │ │ Prefix Dial Command ATDT░░░░░░░░░░ │ │ Suffix Dial Command ^M░░░░░░░░░░░░ │ │ Connect Message CONNECT░░░░░░░ │ │ 1st Error Message NO CARRIER░░░░ │ │ 2nd Error Message BUSY░░░░░░░░░░ │ │ 3rd Error Message NO DIAL TONE░░ │ │ 4th Error Message VOICE░░░░░░░░░ │ │ Abort Dial Command ^M░░░░░░░░░░░░ │ │ Hangup Command ^~^~^~+++^~^~^~ATH^M░░ │ │ Redial Cancel Text RING░░░░░░░░░░ │ ╘═════════════════════════════════════════════F1 Help╛ ╚════════════════════════════════════════════════╝ I. Initialization Command (Alt-N/M/M/I) Default: AT E1 Q0 M1 X1 V1 S7=60^M This command resets Hayes and compatible modems to their standard operating parameters. This command may vary depending on the modem being used; consult the modem owner's manual. P. Prefix Dial Command (Alt-N/M/M/P) Default: ATDT This command is used to tone-dial a number on Hayes and compatible modems; it is sent to the modem immediately before the telephone number to be dialed. For pulse-dialing, use the "ATDP" command. The dialing commands may vary depending on your modem brand. Consult the modem manual for additional information. 22 Qmodem Operations Manual If your modem requires a 150 millisecond BREAK signal for dialing, change this command to the word BREAK. NOTE: Adding *70 after the ATDT dial command can be used to disable call-waiting on some tone-dialing phone systems. Adding 1170 after the ATDP dial command can be used to disable call-waiting on some pulse-dialing phone systems. Check with your phone company to see if these features are supported. S. Suffix Dial Command (Alt-N/M/M/S) Default: ^M (a carriage return) This string immediately follows the number to be dialed. Should your modem require a different End-of-Command character, you should place it here. C. Connect Message (Alt-N/M/M/C) Default: CONNECT The message returned by the modem when a successful connection has been established. Most modems will also return the connect speed as part of the message, IE: "CONNECT/2400". Do not include a speed value as part of this message. Doing so will prevent a connection if the baud rate is different from the one you entered. 1. Error Message 1 (Alt-N/M/M/1) 2. Error Message 2 (Alt-N/M/M/2) 3. Error Message 3 (Alt-N/M/M/3) 4. Error Message 4 (Alt-N/M/M/4) Defaults: BUSY NO CARRIER NO DIAL TONE NO CONNECT These error messages are returned by the modem when the connection could not be established. Your modem may return different messages; refer to the manual for additional information. Version 4.0 23 NOTE: Many modems can be set to return NUMERIC codes rather than VERBAL messages. Although either can be used, you should use the more descriptive verbal messages. If the modem is set to return numeric codes, Qmodem will not be able to determine the connect speed. A. Abort Dial Command (Alt-N/M/M/A) Default: ^M (carriage return) This string will be sent to the modem when a dial request is to be cancelled (IE: pressing [ESC] from the dialing directory screen while dialing is in progress). Most modems accept ^M. If the modem supports "dropping DTR" as a disconnect method, the word DTR (Data Terminal Ready)should be entered in this field. Consult the modem manual for information on this feature. H. Hangup Command (Alt-N/M/M/H) Default: ^~^~^~+++^~^~^~ATH0^M This command will cause Hayes and compatible modem to hang up. Each ^~ pair causes a 1/2-second delay. In the example above, the +++ modem escape sequence is preceded and followed by a 1.5 second delay. This delay, referred to as "escape guard time" is required for the modem to recognize the escape sequence and switch to command mode. The ATH0^M command then instructs the modem to go on-hook (hang up). For modems which recognize "dropping" of the DTR signal as a disconnect method, specify the word "DTR" in this field. To hang up, Qmodem disables the DTR signal, pauses, and then re- establishes it. This hardware-only method, if supported by your modem, is far more reliable than using a modem software command which could easily fail (IE., because of line noise). The reason the DTR method is not the default is that, unfortunately, not all modems support DTR disconnect control. Specifying "BREAK" will send the modem BREAK signal for 150 milliseconds. Some modems attached to PBX (Public Board eXchange, a.k.a. switchboard) require a BREAK in order to disconnect a call. 24 Qmodem Operations Manual R. Redial Hangup Text (Alt-N/M/M/R) Default: RING This message text, when received, will cause Qmodem to stop dialing immediately. If you are sharing a voice line with your modem, this allows you to answer the phone personally. If your modem is connected to its own dedicated phone line, this field can be left blank. Alt-N/M/P Port Addresses ______________________________________________________________________ When the Port Address option is selected, the following menu will be displayed: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files * Options Exit │ ╘════╒════════════════════════════╕═════════════════════════════════════F1 Help╛ │ Communication Parameters │ │ Modem Commands * │ │ Port Addresses │ ╘═══╒═════════════════════╕lp╛ │ A - COM1 Base 03F8 │ │ B - COM2 Base 02F8 │ │ C - COM3 Base 03E8 │ │ D - COM4 Base 02E8 │ │ E - COM5 Base 3220 │ │ F - COM6 Base 3228 │ │ G - COM7 Base 0000 │ │ H - COM8 Base 0000 │ │ I - COM1 IRQ 4 │ │ J - COM2 IRQ 3 │ │ K - COM3 IRQ 4 │ │ L - COM4 IRQ 3 │ │ M - COM5 IRQ 3 │ │ N - COM6 IRQ 3 │ │ O - COM7 IRQ 0 │ │ P - COM8 IRQ 0 │ ╘══════════════F1 Help╛ ╚════════════════════════════════════════════════╝ Version 4.0 25 A.- H. COMx Base (Alt-N/M/P/x) These are the computer's COM port hardware addresses. Qmodem supports default assignments for two serial ports, COM1: and COM2:. For PC/XT/AT and compatibles equipped with IBM-standard adapters, the port address and IRQ assignments need not be changed. IBM PS/2 units also support the COM3: and COM4: ports with the following assignments: Port # Address IRQ ---------------------------- COM3: 3220 3 COM4: 3228 3 NOTE: On non-PS/2 machines, port assignments above COM2 are non-standard. Refer to the adapter or internal modem's documentation for specific hardware information. I.- P. COMx IRQ (Alt-N/M/P/x) The IRQ (Interrupt ReQuest) value must be known for the serial ports to be accessed. When specifying Base addresses for non- standard COM ports, you must also set the correct IRQ values. Failure to set the IRQ will prevent Qmodem from accessing the COM port and will make communications impossible. Refer to the previous example for setting up a PS/2 COM3: or COM4: board. Alt-N/D Directories ______________________________________________________________________ Qmodem directories are defined in the Directories Menu. When selected, the following window is displayed: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files * Options Exit │ ╘══════════════╒═════════════════════════════════════════════╕══════════F1 Help╛ │ Upload ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ │ Download Z:\DL\░░░░░░░░░░░░░░░░░░░░░░░░ │ │ Scripts Z:\SCRIPTS\░░░░░░░░░░░░░░░░░░░ │ ╘══════════════════════════════════════F1 Help╛ ╚════════════════════════════════════════════════╝ 26 Qmodem Operations Manual Note that all the fields in this menu are added and edited manually, following the procedures outlined earlier in this section. U. Upload (Alt-N/D/U) The default drive:\directory which will be searched for files which are uploaded to the remote computer. If this field is left blank, the current directory will be searched. This directory will be displayed in the file allocation window following the PgUp upload command. If you exchange many files with remote computers, you may want to assign the same directory for uploads and downloads. D. Download (Alt-N/D/D) The default drive:\directory into which downloaded files will be stored. If this field is left blank, files will be stored into the current directory. This directory will be displayed in the file allocation window following the PgDn download command. If you exchange many files with remote computers, you may want to assign the same directory for uploads and downloads. S. Scripts (Alt-N/D/S) The drive:\directory path which will be searched for all Qmodem script files. If this directory is not defined correctly, scripts files will not be accessible. NOTE: The above are all DEFAULT directories. Uploads, downloads, and script commands all use the standard Qmodem File Allocation Window (FAW) which allows directory specifications to be changed before the commands are executed. Version 4.0 27 Alt-N/H Host ______________________________________________________________________ If you plan on using Qmodem's Host Mode, be sure to read the Host documentation section completely. When the Host option is selected, the following menu is displayed: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files * Options Exit │ ╘═════════════╒═══════════════════════════════════════════════════╕═════F1 Help╛ │ Type of System OPEN │ │ Download Dir C:\QMODEM\HOSTDIR\░░░░░░░░░░░░ │ │ Upload Dir C:\QMODEM\HOSTDIR\░░░░░░░░░░░░ │ │ Maximum Time 60 │ │ DOS Password PASSWORD │ │ Shutdown Password PASSWORD │ │ Init Command ATE1Q0V1X1S0=0^M░░░░░░░░░░░░░░ │ │ Answer Command ATA^M░░░░░░░░░ │ │ OK Message OK░░░░░░░░░░░░ │ │ Ring Detect RING░░░░░░░░░░ │ │ Busy Command ATM0H1^M░░░░░░ │ ╘════════════════════════════════════════════F1 Help╛ ╚═══════════════════════════════════════════════╝ The Qmodem Host mode operates as a mini Bulletin Board System, complete with electronic messages, sysop chat, and file transfer capabilities. T. Type of System (Alt-N/H/T) Default: OPEN Press [ENTER] to cycle through the 3 possible settings: OPEN, CLOSED and CALLBACK. An OPEN system is easiest to setup and get running. As new callers log in, the Host Password (.PWD) file is automatically updated. All new users are assigned a security level of "0". In a CLOSED system, authorized callers' names and passwords must be defined in the Password file before callers are given access. If the caller's name is not on file, the Host issues a polite "Sorry, this is a closed system" message and hangs up. 28 Qmodem Operations Manual CALLBACK mode is similar to a CLOSED system in that it requires the callers' name and passwords to be in the Password file. In addition, CALLBACK requires that the callers' DATA Phone Number also be on file. When callers log on successfully, they will be instructed to hang up and place their modem into Auto-Answer mode. The Host will then hang up and immediately dial the caller's data phone number. CALLBACK is a very secure system since it insures that all communications originate from known locations. D. Download Dir (Alt-N/H/D) This is the Host Mode equivalent of the Qmodem default download directory. Any valid DOS directory may be entered in this field. All files available for download from the Host must be stored in this directory. The Host "File List" command will produce a list of the files in this directory. Example: C:\QMODEM\HOSTDIR\ U. Upload Dir (Alt-N/H/U) This is the Host equivalent of the Qmodem default upload directory. Any valid DOS directory may be entered in this field. All uploaded files will be stored into this directory. If the Upload and Download directories are the same, all uploaded files become public and are available for download. Example: C:\QMODEM\HOSTDIR\UPLOADS\ M. Maximum Time (Alt-N/H/M) This defines the maximum time allowed per call, in minutes. The default value is 60 minutes, or 1 hour. The maximum time allowed is 999 minutes (16 hours 39 minutes). O. DOS Password (Alt-N/H/O) The password required to "Drop to DOS" from remote. If this field is left blank, all callers may drop to DOS. Version 4.0 29 S. Shutdown Password (Alt-N/H/S) Used to restrict access to the Host Shutdown command. It is strongly recommended that the Shutdown Password be unique and given out only to your most trusted friends. If the correct password is entered, the system hangs up immediately and Host mode is terminated. I. Init Command (Alt-N/H/I) Default: ATE1Q0V1X1S0=0^M This command string is sent to the modem each time Host mode is initialized and after each call. The Host Initialization string should set Verbose result codes (Q0V1), no Auto-Answer (S0=0), and on hook waiting for call (H0). The commands in parentheses are valid for Hayes and compatible modems. A. Answer Command (Alt-N/H/A) Default: ATA^M The Answer Command string is sent to the modem when an incoming call (RING) is detected. For Hayes and compatible modems, use the "ATA^M" command. K. OK Message (Alt-N/H/K) Default: OK The modem returns an "OK" message when the last command was received and executed successfully. For Hayes and compatible modems, use "OK". For modems which do not return a response to the Initialization command, leave this field blank. R. Ring Detect (Alt-N/H/R) Default: RING When an incoming call is detected by the modem, it returns a special "Ring Detect" message. For Hayes and compatible modems, this is the word "RING". When the ring detect message is received, the Host sends the Answer Command to the modem. 30 Qmodem Operations Manual B. Busy Command (Alt-N/H/B) This allows you to place the modem Off-hook when you log in as the local Sysop. Your phone line will return a busy signal preventing callers from connecting to the host system. NOTE: Qmodem does not create subdirectories. If you specified new subdirectories for Uploads and/or Downloads, make sure they exist before starting the Host. Alt-N/P Protocols ______________________________________________________________________ When selecting the Protocols option, the following menu is displayed: ╔═══════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files Options Exit │ ╘═════════════════════════════════╒═══════════════════╕═════════════════F1 Help╛ │ 0 - Zmodem │ │ 1 - Qmail Zmodem │ │ 2 - │ │ 3 - │ │ 4 - │ │ 5 - │ │ 6 - │ │ 7 - │ │ 8 - │ │ 9 - │ │ ASCII Options * │ ╘════════════F1 Help╛ ╚═══════════════════════════════════════════════╝ The Protocols section allows you to customize Qmodem by adding additional external transfer protocols. These protocols can then be called from an upload or download and used as if it were built into Qmodem! The popular Zmodem protocol ((c), Omen Technology) is shown in the example above. The ASCII Options are used for customizing the built-in ASCII transfer protocol. Version 4.0 31 Alt-N/P/x Protocol Revisions ______________________________________________________________________ External protocols must be defined in numerical order; with no blanks inbetween. When selecting a number from 0 to 9, the Protocol Definition window will be displayed: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files * Options Exit │ ╘═════════════════════════════════╒═══════════════════╕═════════════════F1 Help╛ │ 0 - Zmodem │ ╒═════════════════════════════════╕ │ Select character Z │ │ Protocol Zmodem░░░░░░ │ │ Upload BAT SZ.BAT░░░░░░ │ │ Download BAT RZ.BAT░░░░░░ │ │ Filename Prompt N │ ╘══════════════════════════F1 Help╛ │ 8 - │ │ 9 - │ │ ASCII Options * │ ╘════════════F1 Help╛ ╚════════════════════════════════════════════════╝ The following fields must be defined for each external protocol: S. Select Character (Alt-N/P/x/S) The letter or digit used to select this protocol for a file transfer. Characters A,C,F,G,O,R,X, and Y are reserved for Qmodem internal protocols. P. Protocol (Alt-N/P/x/P) The written name of the protocol as it will appear in the upload/download Protocol Selection Window. U. Upload BAT (Alt-N/P/x/U) The name of the upload batch file for the external protocol. D. Download BAT (Alt-N/P/x/D) The name of the download batch file for the external protocol. 32 Qmodem Operations Manual F. Filename Prompt (Alt-N/P/x/F) Specify "N" for external protocols which include filename as part of the transferred data (IE., Zmodem), and "Y" for protocols which must know the name of the file being received. When "Y" is specified, Qmodem passes the filename to the download batch file as the third command-line parameter (%3). TIP: Qmodem passes the COM Speed, Port, and the optional Filename to the protocol batch file as parameters %1, %2, and %3, respectively. Installing an external protocol. ______________________________________________________________________ Because of their changing nature, and to insure that you use the latest versions, external protocol drivers are no longer distributed with Qmodem. We will use Zmodem as an example to illustrate the various steps required in installing an external protocol. Files you will need: 1. The DSZ.COM program. Usually found on most BBS's as DSZmmdd.ARC. "mmdd" represent the release date of the current release (WARNING: in the case of DSZ, new releases can appear on a daily or weekly basis; the one you downloaded today may be obsolete tomorrow). 2. The RZ.BAT (Receive Zmodem) batch file, used for Zmodem downloads. 3. The SZ.BAT (Send Zmodem) batch file, used for Zmodem downloads. 4. The DSZ.DOC documentation file without which you will be lost, and with which you will be utterly confused. You may now select the first unassigned entry in the Alt-N/P menu. The Revise window will be displayed. Edit the fields to make the above example. Next, edit the RZ.BAT file as follows, using the Qmodem Internal Editor (or your own favorite): ╔════════════════════════════════════════════════╗ Echo OFF Echo *** QMODEM Function Keys Disabled During DSZ Operation! *** DSZ port %2 handshake slow rz c:\qmodem\download ╚════════════════════════════════════════════════╝ Version 4.0 33 The download directory specified in the DSZ command line should match the download directory defined in the Alt-N/D/D setup menu. If none is specified, the file will be saved in the current directory. Next, edit the SZ.BAT file as follows: ╔════════════════════════════════════════════════╗ Echo OFF Echo *** QMODEM Function Keys Disabled During DSZ Operation! *** DSZ port %2 handshake slow sz %3 ╚════════════════════════════════════════════════╝ One last step... Make sure the DSZ.COM program is in your Qmodem directory or in a directory in the DOS PATH= so it is accessible by Qmodem. That's it! Installation of other external protocols is similar. Refer to the protocol documentation to insure that upload and download batch file commands are coded correctly. Alt-N/P/A ASCII Options ______________________________________________________________________ The ASCII Options are used to define the parameter which control ASCII (text) file transfers. The ASCII option features separate menus for Receive and Transmit operations: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files Options Exit │ ╘═════════════════════════════════╒═══════════════════╕═════════════════F1 Help╛ │ 0 - Zmodem │ │ 1 - Qmail Zmodem │ │ 2 - │ │ 3 - │ │ 4 - │ │ 5 - │ │ 6 - │ │ 7 - ╒════════════╕ │ 8 - │ Receive │ │ 9 - │ Transmit │ │ ASCII Options *╘═════F1 Help╛ ╘════════════F1 Help╛ ╚════════════════════════════════════════════════╝ 34 Qmodem Operations Manual Alt-N/P/A/R ASCII Receive ______________________________________________________________________ When you select the ASCII Receive option, the following menu is displayed: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files Options Exit │ ╘═════════════════════════════════╒═══════════════════╕═════════════════F1 Help╛ │ 0 - Zmodem │ │ 1 - Qmail Zmodem │ │ 2 - │ │ 3 - │ │ 4 - │ │ 5 - │ │ 6 - │ │ 7 - ╒════════════╕ │ 8 - │ Receive │ │ 9 -╒════════════════════════════════════╕ │ ASC│ Use INPUT Translate Table OFF │ ╘════│ Carriage Return Handling NONE │ │ LineFeed Handling NONE │ ╘═════════════════════════════F1 Help╛ ╚════════════════════════════════════════════════╝ U. Use INPUT Translate Table (Alt-N/P/A/R/U) When ON, all incoming data will be translated. Translation criteria are defined in the Alt-A INPUT Translate Table. If this parameter is OFF, the data is not translated and is received exactly as it was sent. C. Carriage Return Handling (Alt-N/P/A/R/C) This option has three setting: NONE No special treatment of the CR. (Decimal 13) STRIP All CR's are removed from the file as it is saved. ADD LF Adds a trailing LF (Decimal 10) after each CR. Version 4.0 35 L. LineFeed Handling (Alt-N/P/A/R/L) This option also has three settings: NONE No special treatment of LF. (Decimal 10) STRIP All LF's are removed from the file as it is saved. ADD CR Adds a CR (Decimal 13) before each LF. Example: Lines of data sent by a Mainframe end with a single LF (linefeed). You wish to save the data to a file and edit it with an editor or word processor. In this case, a carriage return character should be added in front of each trailing LF and the ASCII receive options should be set as follows: ╔══════════════════════════════════════════════════╗ ╒════════════════════════════════════╕ │ Use INPUT Translate Table OFF │ │ Carriage Return Handling NONE │ │ LineFeed Handling ADD CR │ ╘═════════════════════════════F1 Help╛ ╚══════════════════════════════════════════════════╝ If the text lines ended with CR/CR/LF, you would set the following options: ╔══════════════════════════════════════════════════╗ ╒════════════════════════════════════╕ │ Use INPUT Translate Table OFF │ │ Carriage Return Handling STRIP │ │ LineFeed Handling ADD CR │ ╘═════════════════════════════F1 Help╛ ╚══════════════════════════════════════════════════╝ The above options will remove (strip) both incoming CR, and add a leading CR to each LF (exactly what the doctor ordered!) 36 Qmodem Operations Manual Alt-N/P/A/T ASCII Transmit ______________________________________________________________________ When the ASCII Transmit options is selected, the following menu is displayed: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files Options Exit │ ╘═════════════════════════════════╒═══════════════════╕═════════════════F1 Help╛ │ 0 - Zmodem │ │ 1 - Qmail Zmodem │ │ 2 - │ │ 3 - │ │ 4 - │ │ 5 - │ │ 6 - │ │ 7 - ╒════════════╕ │ 8 - │ Receive │ │ 9 - │ Transmit │ │ ASC╒═════════════════════════════════════╕ ╘════│ Use OUTPUT Translate Table OFF │ │ Carriage Return Handling NONE │ │ LineFeed Handling NONE │ │ Pacing Speed 0 │ │ pAcing Character NONE │ │ Blank Line Expansion ON │ │ End of Line Character 10 │ ╘══════════════════════════════F1 Help╛ ╚════════════════════════════════════════════════╝ U. Use OUTPUT Translate Table (Alt-N/P/A/T/U) When set to ON, outgoing data is translated. Translation criteria are defined in the Alt-A OUTPUT Translate table. When OFF, the data is not translated and is sent "as is". C. Carriage Return Handling (Alt-N/P/A/T/C) This option has three setting: NONE No special treatment of the CR. (Decimal 13) STRIP All CR's are removed while the file is transmitted. ADD LF Adds a trailing LF (Decimal 10) after each CR. Version 4.0 37 L. LineFeed Handling (Alt-N/P/A/T/L) This option also has three settings: NONE No special treatment of the LF. (Decimal 10) STRIP All LF's are removed while the file is transmitted. ADD CR Adds a leading CR (Decimal 13) before each LF. P. Pacing Speed (Alt-N/P/A/T/P) Pacing controls the speed of the data transfer to the remote computer. If the remote computer is able to receive text data at high speed, this value should be zero, the default. If you experience problems sending ASCII data without any pacing, insert a delay between each transmitted character by increasing the Pacing Speed value. Pacing Speed is expressed in milliseconds (1000 = 1 second). 25 milliseconds (1/40 sec) is a good starting value. A. pAcing Character (Alt-N/P/A/T/A) If a pacing character is specified, Qmodem will wait until that character is received before it sends the next line of text. If NONE is specified, the transfer will not pause between lines of text. Use this only when you are sure that the remote system always prompts for each line of text with the same character. To change the setting, use the Up and Down arrow keys to move through the ASCII character set and press [ENTER] when the desired character is displayed. In some cases, you may want to control transmission pacing yourself. Qmodem allows you to do just that by setting the pacing character to ASCII 255 (or any other character which you know will not be received by the other system). When Qmodem pauses after sending each line, press any key to send the next line. Repeat this procedure until the entire file has been transmitted. See also: End Of Line Character. B. Blank Line Expansion (Alt-N/P/A/T/B) This option controls whether or not blank lines (lines which only contain a CR and/or LF and no other text) should be expanded to include at least one SPACE as a leading character. 38 Qmodem Operations Manual NOTE: Many online systems and BBS's interpret a blank line, as defined above, as an end-of-message indication. If your text contains blank lines, the first one will cause the other system to stop receiving message text, issue an end-of-message prompt, and wait for your input. Since additional message text is still being sent, unpredictable results can occur. Setting Blank Line Expansion ON will eliminate this problem. E. End Of Line Character (Alt-N/P/A/T/E) Often referred to as EOL, this is the character that your text editor uses as the last character in a line. Most often (IE., with the Qmodem Internal Editor), this is a LineFeed character (ASCII 10), which is usually preceded by a Carriage Return (ASCII 13). If your text editor or word processor uses a different EOL character, you should define it here. NOTE: Setting this value incorrectly results in a jerky or incomplete transmission. Example: You want to upload a message to your local PCBoard BBS system. The message text was created with the Qmodem Internal Editor (a good combination). PCBoard starts each message line with a colon ":", which we can use as the pacing character. PCBoard also terminates message entry when a blank line is received. To successfully upload the message, the ASCII transmit options should be set as follows: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════════╕ │ Use OUTPUT Translate Table OFF │ │ Carriage Return Handling NONE │ │ LineFeed Handling NONE │ │ Pacing Speed 0 │ │ pAcing Character : 58 │ │ Blank Line Expansion ON │ │ End of Line Character 10 │ ╘══════════════════════════════F1 Help╛ ╚════════════════════════════════════════════════╝ Version 4.0 39 Alt-N/F Files ______________________________________________________________________ Qmodem requires access to specific files and programs which must be defined in the Files menu: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files * Options Exit │ ╘════════════════════════════╒══════════════════════════════════════════════╕lp╛ │ Online Help C:\QMODEM\QMODEM.HLP░░░░░░░░░░ │ │ Screen Dump C:\QMODEM\SCREEN.DMP░░░░░░░░░░ │ │ Capture C:\QMODEM\CAPTURE.CAP░░░░░░░░░ │ │ Log C:\QMODEM\QMODEM.LOG░░░░░░░░░░ │ │ BackScroll C:\QMODEM\BACKSCRL.SAV░░░░░░░░ │ │ View L ░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ ╘═══════════════════════════════════════F1 Help╛ ╚════════════════════════════════════════════════╝ O. Online Help (Alt-N/F/O) This is the Qmodem online help file, distributed as part of the Qmodem program. The default name for this file is QMODEM.HLP. Example: C:\QMODEM\QMODEM.HLP S. Screen Dump (Alt-N/F/S) This is the file to which Qmodem screen dumps (Alt-T) are saved. Qmodem automatically appends the .DMP suffix to the specified filename if one is not included. Example: C:\QMODEM\SCREEN.DMP C. Capture (Alt-N/F/C) This is the file where session data is recorded when Capture (Ctrl-Home) is ON. Qmodem automatically appends the .CAP suffix to the filename if one was not specified. Example: C:\QMODEM\CAPTURE.CAP 40 Qmodem Operations Manual L. Log (Alt-N/F/L) This is the file where Qmodem logs all activity. The Qmodem Log can be started automatically (Alt-N/O/T/U -- aUto Log Start) or explicitly with the Alt-0 command. Qmodem automatically appends the .LOG suffix to the filename if one was not specified. Example: C:\QMODEM\QMODEM.LOG B. Backscroll (Alt-N/F/B) This is the file to which the scroll-back buffer is copied. Qmodem does not assign a default suffix to this file. Example: C:\QMODEM\SCROLL.SAV V. View (Alt-N/F/V) This is the path and filename of the program which is executed by the Alt-V command. Any valid program can be executed by Alt-V, making this a powerful function. Example: ╔══════════════════════════════════════════════════╗ │ View C:\UTILITY\LIST ░░░░░░░░░░░░░░ │ ╘═══════════════════════════════════════F1 Help╛ ╚══════════════════════════════════════════════════╝ Two special keywords may also be specified as a View option: @FSE and @EDITOR. If @FSE if specified, the Qmodem Internal Editor will be used for all file viewing and editing. Example: ╔══════════════════════════════════════════════════╗ │ View @FSE ░░░░░░░░░░░░░░░░░░░░░░░░░ │ ╘═══════════════════════════════════════F1 Help╛ ╚══════════════════════════════════════════════════╝ The @EDITOR keyword, if specified, causes the Qmodem Internal Editor to be replaced with an external program of your choice. Version 4.0 41 Example: ╔══════════════════════════════════════════════════╗ │ View @EDITOR QEDIT ░░░░░░░░░░░░░░░░ │ ╘═══════════════════════════════════════F1 Help╛ ╚══════════════════════════════════════════════════╝ If "@EDITOR" is not specified, the Qmodem Internal Editor will be used for internal editing of scripts or note files attached to phone book entries. NOTE: The @EDITOR and @FSE commands should ALWAYS be followed by a space. (as shown in the above examples). NOTE: Qmodem will append new data to the screen dump, capture, log, and back-scroll files if they exist. If they do not, a prompt for their creation will be displayed when the corresponding command is issued. File names may be changed when these recording features are invoked. Alt-N/O Options ______________________________________________________________________ ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files * Options Exit │ ╘═════════════════════════════════════════════════════╒══════════════════════╕p╛ │ Toggles * │ │ Memory │ │ Sounds * │ │ Delays * │ │ Emulation ANSI │ │ Characters * │ ╘═══════════════F1 Help╛ ╚════════════════════════════════════════════════╝ The Options Menus define run-time parameters which control the operation of Qmodem. These parameters fall into the following categories: 42 Qmodem Operations Manual T. Toggles (Alt-N/O/T) "Feature Switches" which control video mode, audible alarm, modem handshaking, etc... This option has a detailed sub-menu. M. Memory (Alt-N/O/M) Qmodem Memory allocations. This option has a detailed sub-menu. S. Sounds (Alt-N/O/S) Allows Fine-tuning of event-specific beeps and bells. This option has a detailed sub-menu. D. Delays (Alt-N/O/D) Allows setting the window display and file transfer delay values. This option has a detailed sub-menu. E. Emulation (Alt-N/O/E) The default terminal emulation mode used by Qmodem. When the cursor is located in this field, pressing [ENTER] cycles through available emulation modes: TTY, ANSI and VT100. TTY and ANSI modes are the most common. VT100 emulation may be required if connecting to a Host Mainframe computer requiring this terminal type. C. Characters (Alt-N/O/C) The character values used as field delimiters or function indicators in the various screens and in the Qmodem status line. This option has a detailed sub-menu. Version 4.0 43 Alt-N/O/T Options Toggles ______________________________________________________________________ Qmodem toggles are 16 parameters which can be set ON or OFF to control specific aspects of Qmodem operation: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files Options Exit │ ╘═════════════════════════════════════════════════════╒══════════════════════╕p╛ │ Toggles * │ ╒════════════════════════╕│ │ Xon/Xoff flow ON ││ │ bios Video mode OFF ││ │ PCjr mode OFF ││ │ Beeps & Bells OFF ││ │ Linefeed after CR OFF │╛ │ ANSI music player OFF │ │ CTS signal ON │ │ CTS when Writing ON │ │ Redial sets baud OFF │ │ DEL/^H Backspace OFF │ │ aUto start log ON │ │ Snow checking OFF │ │ Growing windows OFF │ │ sTatus line ON │ │ FIFO during Shell OFF │ │ Keypad emulation ON │ ╘═════════════════F1 Help╛ ╚════════════════════════════════════════════════╝ X. Xon/Xoff (Alt-N/O/T/X) Xon/Xoff is a software flow control protocol used during normal text and ASCII transmissions. This toggle can also be changed from terminal mode with the Alt-Z command. XOFF and XON are ^S (Ctrl-S) and ^Q (Ctrl-Q) characters, respectively. Most BBS and mainframe systems use XOFF and XON as a method of pacing text data transmissions. If the XON/XOFF toggle is ON, Qmodem will send the XOFF character when its receive buffer is full, and will display the following message on the Status line: " Buffer FULL - Keyboard Input Suspended - Please Wait " As text is displayed, the receive buffer empties and can accept more data. Qmodem then sends the XON character to resume transmission and restores the normal status line. 44 Qmodem Operations Manual V. BIOS Video (Alt-N/O/T/V) When OFF, Qmodem writes directly to screen memory, which results in extremely fast screen displays. When ON, all screen displays are performed via calls to the system's ROM BIOS, and screen displays are much slower. BIOS Video mode must be ON when Qmodem operates under multi-tasking software such as DoubleDOS or Windows/386. TIP: Qmodem is fully DESQview "aware". When running Qmodem under DESQview, set BIOS Video mode to "NO". With other multi-tasking programs, you should experiment with this setting to determine the best operating mode. P. PCjr mode (Alt-N/O/T/P) This toggle should be ON when running Qmodem on an IBM PCjr computer. When ON, this causes Qmodem to access the serial port with slower BIOS routines. In PCjr mode, the maximum serial speed is limited to 4800 baud. Speeds settings greater than 4800 will be ignored when selected with the Alt-P command. B. Beeps & Bells (Alt-N/O/T/B) Activates or deactivates the Qmodem audible signals produced when connecting to another computer, or at the completion of a file transfer. This toggle can be changed with the Alt-B command. L. Linefeed after CR (Alt-N/O/T/L) Setting this ON causes Qmodem to add a linefeed (LF) character after every carriage return (CR) characters. This may be needed if text lines wrap around and get over-written on the screen. This toggle can be changed via the Shift-Tab command. A. ANSI Music (Alt-N/O/T/A) Setting this ON will permit Qmodem to play ANSI music if found in the incoming data stream. This toggle can be changed via the Alt-M command. Version 4.0 45 C. CTS/RTS Signal (Alt-N/O/T/C) When set to ON, Qmodem implements hardware handshaking between the modem and computer. This is required for high-speed and error-correcting modems. Since additional signals are required to implement hardware handshaking, make sure that your external modem cable (if any) supports all the required signal lines. W. CTS when Writing (Alt-N/O/T/W) This toggles determines CTS/RTS hardware flow control when writing to disk during a file download. When this toggle is OFF, Qmodem drops the RTS signal while writing data to the disk, and re-establishes RTS after the data has been written, and the transmission resumes. When this toggle is ON, the RTS signal remains on during the disk writes. This allows Qmodem to overlap disk and serial port activity while downloading data on systems equipped with hardware-handshaking modems (IE, high-speed or MNP modems). For this option to work properly, the Alt-N/O/T/T (CTS enable) flag must be ON. Normally, the RTS (Request To Send) signal line is dropped low (turned off) whenever a block of data is being written to disk. This stops the modem from sending data to the computer during that time, which could cause data loss due to a missed interrupt. TIP: If your computer and hard disk are fast enough, you can gain a small but measurable increase in download speed by using this option. CAUTION: If you are downloading across a network to a file server drive, it is strongly recommended that you DO NOT use this option. R. Redial Sets Baud Rate (Alt-N/O/T/R) When set to ON, Qmodem will set the serial port speed to the connect speed identified in the modem's CONNECT message. When OFF, Qmodem maintains the serial port speed defined in the phone book entry being dialed. 46 Qmodem Operations Manual D. Del/^H Backspace (Alt-N/O/T/D) This toggle defines the character which is generated when the [BACKSPACE] key is pressed. When OFF, a ^H (standard backspace character) is generated. When ON, a DEL is generated. This toggle can be changed via the Alt-1 command. TIP: Pressing [Ctrl-Backspace] will send the reverse of this toggle. For example, if ON, ^backspace will send a ^H character. U. aUto Start Log (Alt-N/O/T/U) When this toggle is ON, Qmodem will automatically record activity in the LOG file defined in Alt-N/F/L when first started. If set to OFF, activity logging must be started explicitly with the Alt-0 command. S. Snow Checking (Alt-N/O/T/S) Older CGA display adapters (and some CGA clones) may exhibit "snow" when video memory is accessed. If this is the case, set this toggle to ON. Qmodem will use a different memory access method which may help alleviate the problem. This toggle is not used if your system is equipped with an MDA, EGA, or VGA display. TIP: While running under DESQview, you can set this to OFF for slightly improved display speed. G. Growing Windows (Alt-N/O/T/G) Controls the method used to display windows on screen. When ON, windows will "grow" or "explode" onto the screen. When OFF, windows will pop onto the screen instantly. T. sTatus Line (Alt-N/O/T/T) This toggle controls displaying of the status line (the last line of the physical screen). When OFF, the Qmodem status line is not displayed and the last screen line is available for incoming text display. NOTE: The Screen will clear when this toggle is changed. Version 4.0 47 F. FIFO during Shell (Alt-N/O/T/F) This toggle only applies to systems with serial adapters equipped with a 16550 or 16550A UART, which feature a First-In, First-Out (FIFO) data buffer. When ON, Qmodem leaves the 16550/16550A UART in FIFO mode. When OFF, Qmodem disables the FIFO buffer, and the 16550x UART runs in 16450 compatibility mode. Some external transfer protocols may require this toggle to be OFF for correct operation. If your external transfer program aborts immediately upon startup, try setting this to OFF and execute the external again. NOTE: This toggle only works if Qmodem detects the 16550/16550A UART in your system at startup. In beta tests of Qmodem 4.0, FIFO buffer operation improved performance significantly in systems running under DesqView and equipped with high-speed modems. CAUTION: Problems may occur when upgrading from an 8250 or 16450 UART to the newer 16550/16550A/16550AN chips. Although they are pin-compatible, the 16550 series are a superset of the older chips and require additional connections not used in the older components. Some serial adapters made specifically for the older chips may not be able to operate properly with the newer chips. K. Keypad emulation (Alt-N/O/T/K) This toggle controls numeric keypad operation when the keyboard NumLock toggle is ON. When Keypad emulation is ON, pressing a cursor key will send the correct cursor control sequence, as defined in the Terminal Emulation section of the manual. When set to OFF, the keypad functions normally. NOTE: Refer to the Alt-G Emulations sections for a complete description of the keypad. 48 Qmodem Operations Manual Alt-N/O/M Options Memory ______________________________________________________________________ Qmodem allows user-specified memory allocations for five specific storage areas: The scroll-back buffer, variables used by script files, the Qmodem internal editor, the download buffers and the Overlay memory allocation. These values can be changed to meet varying requirements. ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files * Options Exit │ ╘═════════════════════════════════════════════════════╒══════════════════════╕p╛ │ Toggles * │ │ Memory │ ╒════════════════════════════╕ │ Lines of Scroll-back 50 │ │ Script variables (K) 5 │ │ Editor memory (K) 20 │ │ Download Buffer 8 │ │ Overlay Buffer (K) 20 │ ╘═════════════════════F1 Help╛ ╚════════════════════════════════════════════════╝ L. Lines of Scroll-back (Alt-N/O/M/L) Memory is allocated as the maximum number of lines which can be stored in the scrollback buffer. Each screen requires approximately 1,900 characters of memory. For example, to recall the last 480 lines (20 screens) would require approximately 38k of memory. S. Script Variables (Alt-N/O/M/S) While executing a script, memory must be available for the storage of variables. Requirements vary, based on the needs of the scripts being executed. A reasonable starting value is 3 or 4K. If scripts are NOT used, no memory need be allocated. E. Editor Memory (Alt-N/O/M/E) The Qmodem internal editor stores the entire file being edited in memory for performance reasons. Memory requirements depend on the size of largest file to be edited. If only small files will be edited, a good starting value is 6 to 8K. Version 4.0 49 D. Download Buffer (Alt-N/O/M/D) Downloaded data is stored into the download buffer. When the buffer is full, it is copied to disk. Each buffer is 128 bytes, and from 8 to 240 buffers can be allocated. When receiving to a fast hard disk or to a RAM disk, use the smallest allocation (8). A low allocation when downloading to a diskette will reduce transmission efficiency. Large allocation are at the expense of system RAM memory. O. Overlay Buffer (Alt-N/O/M/O) Available ONLY in the overlay version of Qmodem. The default value is 20K. Increasing this value will reduce disk activity during the loading of program overlay files at the expense of memory. TIP: If Qmodem seems too slow, this value should be increased in 5-10K increments until execution speed is satisfactory. Since the above memory allocations cannot vary during program execution, a change cannot go into effect without stopping and restarting Qmodem. After such a change has been made, a warning message to that effect will be displayed. Upon exiting the menu, Qmodem will also issue an exit prompt to remind the user of this condition. If memory changes were made while online, Qmodem can be stopped with the Alt-X/X command and restarted in order to continue the online connection. NOTE: Memory available to Qmodem may vary greatly depending on the operating system's own requirements, and resident programs (TSRs) loaded. If Qmodem is unable to find sufficient memory, it will re-allocate it using a best- fit algorithm and will issue a warning message to that effect. 50 Qmodem Operations Manual Alt-N/O/S Options Sounds ______________________________________________________________________ ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files * Options Exit │ ╘═════════════════════════════════════════════════════╒══════════════════════╕p╛ │ Toggles * │ │ Memory │ │ Sounds * │ │╒══════════════════════╕ ││ Connect tones │ ││ Upload tone 200 │ ╘│ Download tone 200 │ ╘═══════════════F1 Help╛ ╚════════════════════════════════════════════════╝ Qmodem can generate various sounds to signal a successful connect or the completion of a file transfer. Whether or not sounds are generated is controlled by the Alt-N/O/T/B toggle, or the Alt-B command in terminal mode. These sounds can be customized in the Options Sounds menu: C. Connect Tones (Alt-N/O/S/C) This multi-note jingle has its own custom menu. U. Upload tone (Alt-N/O/S/U) D. Download tone (Alt-N/O/S/D) A single beep will be produced at the completion of each file transfer. The frequency of the sound can be changed. A sample beep will be heard after each change. The default frequency for the file transfer completion tones is 1200 cycles. Version 4.0 51 Alt-N/O/S/C Options Sounds Connect tones ______________________________________________________________________ ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files * Options Exit │ ╘═════════════════════════════════════════════════════╒══════════════════════╕p╛ │ Toggles * │ │ Memory │ │ Sounds * │ │╒══════════════════════╕ ││ Connect tones │ ││ Uplo╒═══════════╕00 │ ╘│ Down│ 1 - 123 │00 │ ╘═════│ 2 - 144 │Help╛ │ 3 - 165 │ ╘════F1 Help╛ ╚════════════════════════════════════════════════╝ Qmodem produces a 3-note jingle following a successful connection. The default frequencies for the three notes are 1200, 1400, and 1600 cycles. 1. First Note (Alt-N/O/S/C/1) 2. Second Note (Alt-N/O/S/C/2) 3. Third Note (Alt-N/O/S/C/3) These can be changed to suit your taste. All 3 notes are played following each change. To change a value, type the desired number, type in the new value, and press [ENTER]. 52 Qmodem Operations Manual Alt-N/O/D Options Delays ______________________________________________________________________ Delay values affect the timing of certain Qmodem operations: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files * Options Exit │ ╘═════════════════════════════════════════════════════╒══════════════════════╕p╛ │ Toggles * │ │ Memory │ │ Sounds * │ │ Delays * │ │╒════════════════════╕│ ││ Status window 120 ││ ╘│ File transfers 10 │╛ ╘═════════════F1 Help╛ ╚════════════════════════════════════════════════╝ S. Status Windows (Alt-N/O/D/S) Most toggles or immediate commands have an accompanying window showing the change in Qmodem's status. The value in this field, expressed in hundredths of a second, controls the duration of time these status windows are displayed. The default is 300, for a 3 second duration. F. File Transfers (Alt-N/O/D/F) File transfer errors such as Short/Long blocks can occur on high- speed, buffered modems when the COM port rate is fixed at a high value. Adding a file transfer delay of up to 20 seconds (or more, depending on the system you are communicating with) will correct this problem. NOTE: This should be set to a non-zero value any time the serial port baud rate exceeds the actual connect baud rate. Version 4.0 53 Alt-N/O/C Options Characters ______________________________________________________________________ ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files * Options Exit │ ╘═════════════════════════════════════════════════════╒══════════════════════╕p╛ │ Toggles * │ │ Memory │ │ Sounds * │ │ Delays * │ │ Emulation ANSI │ │ Characters * │ ╒════════════════════════════╕ │ Date Separation / 47 │ │ Time Separation : 58 │ │ Beeps & Bells b 98 │ │ ANSI Music B 66 │ │ Status Line Filler ▒ 176 │ │ Phone Book Tag √ 251 │ │ Notes Tag ≡ 240 │ ╘═════════════════════F1 Help╛ ╚════════════════════════════════════════════════╝ Special characters are used as field separators or function indicators: To change a separator or indicator value, select the desired character and press the Up or Down cursor key to cycle through other available character values. When the desired character is displayed, press [ENTER]. To return a character to its default value, press [ESC]. D. Date Separation (Alt-N/O/C/D) Default: Forward slash " / 47 " This is the character that separates the day, month and year fields in Date related variables. Dates read as MM/DD/YY. TIP: Setting this to " - 45 " allows the script variable $DATE to be used as part of a filename. 54 Qmodem Operations Manual T. Time Separation (Alt-N/O/C/T) Default: Colon " : 58 " This is the character that separates the hours, minutes and seconds in Time related variables. Time reads as HH:MM:SS. B. Beeps & Bells (Alt-N/O/C/B) Default: Single note " (ASCII 13) 13 " This also happens to be the Decimal representation of a CR (carriage return) so it cannot be accurately represented in the Documentation. This is the character used in the Status line to show that the "Beeps & Bells" is toggled ON. TIP: You may want to change this to another character to prevent problems with the DOS Print Screen function. A. ANSI Music (Alt-N/O/C/A) Default: Double note " (ASCII 14) 14 " This is the character used in the status line to show that the "ANSI Music" is toggled ON. TIP: You may want to change this to another character to prevent problems with the PrtSc function. The double musical note character causes Epson and compatible printers to switch to compressed print mode. S. Status Line Filler (Alt-N/O/C/S) Default: Hash block " ░ 176 " This is the character used as an area separator in the Status line. P. Phone Book Tag (Alt-N/O/C/P) Default: Check mark " √ 251 " This character is used in the Alt-D Phone Book to indicate that an entry has been tagged for dialing or other functions. Version 4.0 55 N. Notes Tag (Alt-N/O/C/N) Default: Triplet " ≡ 240 " This character is used in the Alt-D Phone Book to indicate that an entry has an attached Note file. Alt-N/E Exit ______________________________________________________________________ You should always exit the Setup Menu with this option if you want changes to be saved in the Qmodem configuration file. ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Setup Menu ═════════════════════════════════╕ │ Colors * Modem Dirs * Host * Protocols * Files * Options Exit │ ╘═══════════════════════════════════════════════════════════════╒══════════════╕ │ Abandon │ │ Save Changes │ ╘═══════F1 Help╛ ╚════════════════════════════════════════════════╝ The Configuration Exit Menu has two options: A. Abandon (Alt-N/A) Leave the configuration menu and do not save the changes. Pressing [ESC] while at the main menu level has the same effect. This allows changes to be tested before being saved with Alt-N/S. S. Save Changes (Alt-N/S) Save the changes to the QMODEM.CNF file and exit the menu. NOTE: If changes were made to Qmodem memory allocation an exit prompt will be displayed at this time, indicating that Qmodem may be stopped and re-started to put these changes into effect. Upgrading from a previous release ______________________________________________________________________ Qmodem release 4.0 will automatically convert release 3.1 and 3.1a versions of the QMODEM.CNF file and initialize all new fields and options. 56 Qmodem Operations Manual There is no direct conversion procedure available for versions of Qmodem prior to 3.1. You must delete your QMODEM.CNF file and start from scratch. Following is a checklist of things you need to do: Alt-N/C Select one of the pre-defined color sets. Customization can be done later. Alt-N/M/M Check ALL modem commands and replace the "{" (left brace) characters with the "^M" combination. The "{" is no longer valid as a carriage return. Alt-N/M/M/R Check this field. Alt-N/D Select each entry one at a time and press [ENTER] without changing the field. This will add a trailing "\" if it did not already exist. Alt-N/F Select each entry one at a time and press [ENTER] without changing the field. Version 4.0 57 Alt-N/E/S You must Exit and Save for the QMODEM.CNF file to be updated. You will then be presented with the following prompt: ╔════════════════════════════════════════════════╗ ╒═════════════════════ Warning! ═════════════════════╕ │ Memory requirements changed. Do you want to Exit │ │ and restart to put them in effect ? [Y/N/X] _ │ ╘════════════════════════════════════════════F1 Help═╛ ╚════════════════════════════════════════════════╝ Reply "Y" to update QMODEM.EXE with the new memory settings and insure that the QMODEM.EXE and the QMODEM.CNF files match. This will also terminate Qmodem and return you to the DOS prompt. You are finished! Now would be a good time to browse through the entire Alt-N Setup if you have not already done so. Upgrading Qmodem support files ______________________________________________________________________ Four more conversions must still be done before you start Qmodem 4.0 if you are upgrading from previous releases: Phone Book Files ______________________________________________________________________ All of your Phone Book files need to be run through the UPGRADE.EXE program located on the Utilities Disk. UPGRADE is a program to convert Qmodem 3.x FON files to the new 4.0 format. The syntax is : UPGRADE filename 'filename' must be a valid Qmodem FON file and can reside in any subdirectory. You will be asked to verify the conversion before you do something that can only be regretted later (meaning, make SURE you really want to). 58 Qmodem Operations Manual Examples: UPGRADE C:\QMODEM\QMODEM.FON This will convert the QMODEM.FON file in the C:\QMODEM directory. UPGRADE PCPURSUT.FON This will convert the PCPURSUT.FON file in the current directory. Script Files ______________________________________________________________________ The Script files must also be updated before you execute them. The program SCRFIX.EXE on the Utilities Disk is for this purpose. SCRFIX will make the following changes for you: All WHEN and SEND command that use the "{" character will be converted to the "^M" combination. Leading periods '.' are no longer used as comment delimiters. These will be changed to the semicolon ';' which is now the only comment delimiter. SCRFIX will not change the UPLOAD or DOWNLOAD commands, and they do need to be changed before executing them. The old syntax for an UL or DL was: UPLOAD FILENAME PROTOCOL.... The new syntax is: UPLOAD PROTOCOL FILENAME. You need to switch the first two parameters around for the UPLOAD and DOWNLOAD commands to function as before. Do NOT forget this step! .KEY Files ______________________________________________________________________ The Function Key files are now larger in 4.0 than in all previous released. Pre-4.0 files are straight ASCII text files with 40 lines. The new .KEY files are still ASCII text, but contain an additional 8 lines, for a total of 48. Version 4.0 59 Qmodem will convert the KEY files if it detects the older 40 line versions, but the 8 new lines will be added to the END of the existing 40. At first, this sounds ok and you can relax... Well, yes and no. The new format is based on 12 function keys per set with a total of 4 sets. Adding the 8 new lines to the end will "push up" the existing definitions. Everything after the first 10 definitions will appear out of place. To correct for this, simply edit your .KEY files with an ASCII text editor and add two blank lines every 10 lines. Example: Old .KEY file: F1 some text in here F2 some text in here F3 some text in here F4 some text in here F5 some text in here F6 some text in here F7 some text in here F8 some text in here F9 some text in here F10 some text in here SF1 some text in here SF2 some text in here SF3 some text in here SF4 some text in here SF5 some text in here SF6 some text in here SF7 some text in here SF8 some text in here SF9 some text in here SF10 some text in here CF1 some text in here CF2 some text in here CF3 some text in here . . . AF10 some text in here New .KEY file: F1 some text in here F2 some text in here F3 some text in here F4 some text in here F5 some text in here F6 some text in here F7 some text in here 60 Qmodem Operations Manual F8 some text in here F9 some text in here F10 some text in here F11 F12 SF1 some text in here SF2 some text in here SF3 some text in here SF4 some text in here SF5 some text in here SF6 some text in here SF7 some text in here SF8 some text in here SF9 some text in here SF10 some text in here SF11 SF12 CF1 some text in here CF2 some text in here CF3 some text in here . . . AF10 some text in here AF11 AF12 By adding 2 blank lines after every 10 originals, the Shift, Ctrl and Alt functions keys will remain the same as before. The QMODEM.PRE File ______________________________________________________________________ The Phone Book .PRE file has also been enhanced, but actually requires no conversion. It is mentioned here so you will be aware that it has changed. The old format had only 5 entries; +, -, !, @ and #. The new format has 10 entries; A through J. These will be discussed in detail in the Alt-D Dial command. Version 4.0 61 Command Line Parameters ______________________________________________________________________ Certain Qmodem features are (out of necessity) implemented via command-line parameters and have no terminal mode or script command equivalents. Command line parameters are not case-sensitive and may be specified in any order. The following DOS command-line parameters are valid when starting Qmodem: /AUTOZ Allows Qmodem to immediately begin a Zmodem download when the following conditions are detected: o You have an external protocol defined as the letter "Z". o The Zmodem "start header" has been received. This is a late addition to the program, and as such, no equivalent Setup Toggle is included. You must have this command line switch to activate "Auto-Zmodem Downloads." /F Disables the FIFO (First In First Out) buffer in recent 16550/16550A UART serial processor chips. Under some situations, the FIFO buffering mechanism may cause problems such as a locked- up computer or loss of data. If these problems occur and your serial adapter is equipped with a 16550/16550A chip, try this option. /HOST Will invoke the Host Mode immediately after startup. This option can be used to start an unattended Host system as soon as the machine is booted, by adding the Qmodem start command to your AUTOEXEC.BAT file. /NOINT16 Disables the Qmodem Interrupt 16 trap which allows support of the enhanced 101-key keyboard. If your system is equipped with an enhanced keyboard, Qmodem normally intercepts this interrupt so it can process the F11 & F12 function keys. If your computer is not equipped with an enhanced keyboard, the interrupt is not trapped. 62 Qmodem Operations Manual /NVR The acronym for "No Video Restore". The initial video mode is saved upon startup and restored when Qmodem terminates. Depending on your hardware or software environment, this may produce undesirable results. Use this parameter to prevent Qmodem from restoring the initial video mode upon exit. /S=SCRIPT.SCR Autoexec Script: the Qmodem script file to be executed immediately upon startup. The script file must be located in the script directory as specified in Alt-N/D/S or in the current directory if the Alt-N/D/S field is blank. /VEGAVGA=[mode] An Option Specific to the VEGA VGA cards from Video-7 Inc. Allows setting an alternate text mode (like 132x43) from the command line. /XT Instructs Qmodem to treat 80286 or 80386 equipped computers as if they were running the slower 8086/88 type CPU chip. This will make uploads somewhat slower, but will increase file transfer reliability if the normal mode causes problems with lost data. Version 4.0 63 The Internal Editor ______________________________________________________________________ The Internal Editor is a RAM-based editor and similar to the Turbo Pascal & SideKick editors. If you are familiar with either of these, you should need little help in using the Internal Editor (perhaps no more than a look at the Quick Command Reference); novices should read on. Entering and Editing Text ______________________________________________________________________ You enter text into the Internal Editor the same way you would on a regular typewriter. Most keys behave in the same manner; pressing [ENTER] terminates a text line, for example. But there are some important differences too. The cursor always indicates where new text will be entered, and you can move the cursor in a number of ways. You can correct mistakes easily using the Delete commands. You can copy or move blocks of text with the Block commands. You can quickly search the file for a particular text string with the Find commands. And, most of the time, you can "undo" a change with the Line Restore command. Each command (and there are many more) is described briefly in the following section. Quick Command Reference ______________________________________________________________________ Function Keystrokes ______________________________________________________________________ Character left Ctrl-S or Left arrow Character right Ctrl-D or Right arrow Word left Ctrl-A or Ctrl-left arrow Word right Ctrl-F or Ctrl-right arrow Line up Ctrl-E or Up arrow Line down Ctrl-X or Down arrow Scroll up Ctrl-W Scroll down Ctrl-Z Page up Ctrl-R or PgUp Page down Ctrl-C or PgDn Beginning of file Ctrl-QR or Ctrl-PgUp End of file Ctrl-QC or Ctrl-PgDn Beginning of line Ctrl-QS or Home End of line Ctrl-QD or End Top of screen Ctrl-QE or Ctrl-Home Bottom of screen Ctrl-QX or Ctrl-End Top of block Ctrl-QB Bottom of block Ctrl-QK Jump to marker 0..3 Ctrl-Q0..Ctrl-Q3 Set marker 0..3 Ctrl-K0..Ctrl-K3 64 Qmodem Operations Manual Previous cursor position Ctrl-QP New line Ctrl-M or [ENTER] Insert line Ctrl-N Insert control character Ctrl-P Tab Ctrl-I or Tab Delete current character Ctrl-G or Del Delete character left Ctrl-H or Backspace Delete word Ctrl-T Delete to end of line Ctrl-QY Delete line Ctrl-Y Find Ctrl-QF Find-and-replace Ctrl-QA Find next Ctrl-L Begin block Ctrl-KB or F7 End block Ctrl-KK or F8 Copy block Ctrl-KC Move block Ctrl-KV Delete block Ctrl-KY Hide block Ctrl-KH Mark current word as block Ctrl-KT Read block from file Ctrl-KR Write block to file Ctrl-KW Print block Ctrl-KP Toggle insert mode Ctrl-V or Ins Toggle Autoindent mode Ctrl-QI Toggle fixed tabs Ctrl-or Restore line Ctrl-QL Exit editor Ctrl-KD or F10 or Esc ______________________________________________________________________ NOTE: When the notation Ctrl- precedes another key, it means that you hold down the Ctrl key and press the second key. In the case of commands that have a second letter (for example Ctrl-QP), you hold down the Ctrl only while pressing the first letter, not the second. The Editing Screen ______________________________________________________________________ The top line in the Edit Window is called the Edit Status Line and should not be confused with the global Status Line at the bottom of the screen. The Edit Status Line is inside the window and the global is not. Version 4.0 65 The editor screen: ╔════════════════════════════════════════════════╗ ╒══════════════════════════════ Full Screen Edit ══════════════════════════════╕ │^P Line 14 Col 57 Insert Indent Tab E:SAMPLE.DOC │ │ │ │ This text was entered │ │ with autoindent on │ │ │ │ │ │The x's mark the tab stops with fixed tabs on: │ │ x x x x x x x x x │ │Col: 9 17 25 33 41 49 57 65 73 │ │ │ │ │ │The x's mark the tab stops with "smart tabs" on: │ │x x x x x x x x x x │ │ │ │To enter a ^B into the text, you press ^P and then ^B... │ │ │ │ │ ╘══════════════════════════════════════════════════════════════════════F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒ F1-Help F2-Save F3-New F9,ESC-Abort F10-Save & Exit ▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ Command echo When the first key of a command assigned to two keystrokes is pressed, or when the Insert control character command (Ctrl-P, like the example) is given, the keystroke is echoed in the upper left corner of the window on the status line. For example, if you start to enter a command that begins with Ctrl-K (such as Ctrl-KK), a ^K will appear until the second keystroke is entered. Line n Shows the number of the line containing the cursor, counted from the start of the file. Col n Shows the column number containing the cursor. Insert Indicates that Insert mode is in effect. Everything you type will be inserted as opposed to possibly overwriting existing text. Indent Indicates that Autoindent mode is in effect. Ctrl-QI toggles autoindent on and off. 66 Qmodem Operations Manual Tab Indicates that fixed tabs (toggled with Ctrl-or) are in effect. E:SAMPLE.DOC The Drive, name and extension of the file being edited. Although the editor accepts path designations (E:\QMODEM\SCRIPTS\SAMPLE.DOC), the path name will not appear in the status line. Basic Movement Commands ______________________________________________________________________ The basic movement commands are those that move the cursor without altering the text. On IBM PCs an compatibles, the cursor can be moved in one of two ways; with a key on the numeric keypad or with a "control character." For example, to move the cursor to the right one character, you can press either the Right Arrow or Ctrl-D. In the following listings, the key sequence on the left is the primary key sequence and the one on the right, if any, is the secondary key sequence. Either can be modified by running the EDINSTAL program included on the Utilities Disk. NOTE: The online help for the Internal Editor will not reflect any changes you make to the key sequences. Only the default installation is shown. Character left Ctrl-S or Left arrow Moves the cursor one character to the left. This command does not work across line breaks; when the cursor reaches column 1; it stops. Character right Ctrl-D or Right Arrow Moves the cursor one character to the right. This command does not work across line breaks; when the cursor reaches the right-hand edge of the text window, the text starts scrolling horizontally until it reaches the extreme right edge of the line (column 248), where it stops. Word left Ctrl-A or Ctrl-Left arrow Moves the cursor to the beginning of the word to the left. This command works across line breaks. Word right Ctrl-F or Ctrl-Right arrow Moves the cursor to the beginning of the word to the right. This command works across line breaks. Line up Ctrl-E or Up arrow Moves the cursor to the line above. If the cursor is on the top line of the window, the window scrolls down one line. Version 4.0 67 Line down Ctrl-X or Down arrow Moves the cursor to the line below. If the cursor is on the next-to- last line of the window, the window scrolls up one line. Scroll up Ctrl-W Scrolls up toward the beginning of the file, one line at a time. The cursor remains on its line until it reaches the bottom of the window. Scroll down Ctrl-Z Scrolls down towards the end of the file, one line at a time. The cursor remains on its line until it reaches the top of the window. Page up Ctrl-R or PgUp Moves the cursor one page up with an overlap of one line. Page down Ctrl-C or PgDn Moves the cursor one page down with an overlap of one line. Beginning of file Ctrl-QR or Ctrl-PgUp Moves the cursor to the first character in the file. End of file Ctrl-QC or Ctrl-PgDn Moves the cursor to the last character in the file. Beginning of line Ctrl-QS or Home Moves the cursor to column 1 on the current line. End of line Ctrl-QD or End Moves the cursor to the end of the current line (the position following the last nonblank character on the line). Trailing blanks are always removed from all lines to preserve space. Top of screen Ctrl-QE or Ctrl-Home Moves the cursor to the top line of the text window. Bottom of screen Ctrl-QX or Ctrl-End Moves the cursor to the bottom line of the text window. Top of block Ctrl-QB Moves the cursor to the position of the block-begin marker set with Ctrl-KB. This command works even if the block is hidden with the Ctrl-KH command or the block-end marker is not set. Bottom of block Ctrl-QK Moves the cursor to the position of the block-end marker set with the Ctrl-QK command. The command works even if the block is hidden or the block-begin marker is not set. 68 Qmodem Operations Manual Previous cursor position Ctrl-QP Moves the cursor to the last position. This command is useful to move back to the previous position after a Save, a Find, or a Find-and- replace operation. (or in case you hit the wrong direction key!) Jump to marker 0..3 Ctrl-Q0..Ctrl-Q3 Moves the cursor to one of the four invisible text markers created with the Set marker command. Ctrl-Q0 jumps to marker 0, Ctrl-Q1 jumps to marker 1, and so on. If the specified marker has not been set, the cursor is not moved. Set marker 0..3 Ctrl-K0..Ctrl-K3 Sets one of the four invisible text markers at the current cursor position. Ctrl-K0 sets marker 0, Ctrl-K1 sets marker 1, and so on. Insert and Delete Commands ______________________________________________________________________ These commands let you insert and delete characters, words, and lines. Two related commands are covered in later sections: Restore line (Ctrl-QL) and Delete block (Ctrl-KY). New line Ctrl-M or Enter In insert mode, this command inserts a line break at the cursor's current position. If Autoindent mode is in effect, the cursor moves to the next line and to the same column as the first nonblank character in the previous line; otherwise, it moves to column 1 of the new line. In overwrite mode, this command moves the cursor to column 1 of the next line without inserting a new line, whether Autoindent mode is in effect or not. Insert line Ctrl-N Inserts a line break at the cursor's position. The cursor does not move. Insert control character Ctrl-P Allows control characters to be entered into the text. For example, pressing Ctrl-P and then Ctrl-C would insert a Ctrl-C (^C) into the text. Control characters are displayed as capital letters in the same color as the Status Line. Tab Ctrl-I or Tab Moves the cursor to the next tab stop. In Insert mode, any text to the right of the cursor is moved along with it; in Overtype mode, only the cursor is moved. The location of the next tab stop depends on whether fixed tabs or smart tabs are in effect. Version 4.0 69 Delete current character Ctrl-G or Del Deletes the character over the cursor and moves any characters to the right of the cursor one position to the left. This command does not work across line breaks. Delete character left Ctrl-H or Backspace Moves the cursor one character to the left and deletes the character positioned there. Any characters to the right of the cursor are moved one position to the left. If the cursor is in column 1 at the time the command is given, the invisible end-of-line marker for the previous line is deleted instead, and the two lines are joined. Delete word Ctrl-T Deletes the word to the right of the cursor. This command works across line breaks and thus may be used to remove line breaks. Delete to end of line Ctrl-QY Deletes all text from the position of the cursor to the end of the line. Delete line Ctrl-Y Deletes the line containing the cursor and moves any lines below it up one line. The cursor moves to column 1 of the next line. You cannot restore a deleted line, so use this with caution. Block Commands ______________________________________________________________________ A block is any arbitrarily defined, contiguous unit of text; a block can be as small as a single character or as large as the entire file. Mark a block by placing a begin-block marker at the first character in the desired block and an end-block marker just beyond the last character. Once marked, the block can be copied, moved, deleted, or written to a file. Although marked blocks are normally highlighted, the block may be "hidden" (or made invisible) with the Hide block command. Many of the block-manipulation commands described here work only when the block is being displayed. The block-related cursor movement commands (Ctrl-QB and Ctrl-QK, described in the "Basic Movement Commands") work whether the block is hidden or displayed. Begin block Ctrl-KB or F7 Marks the beginning of a block. The marker itself is not visible on the screen, and the block becomes visible only when the end-block marker is set. You can also use the begin-block marker as an extra text marker and jump directly to it with Ctrl-QB. 70 Qmodem Operations Manual End block Ctrl-KK or F8 Marks the end of a block. Like the begin-block marker, the end-block marker is invisible, and the block itself will not be displayed unless both markers are set. You can also use the end-block marker as an extra text marker and jump directly to it with Ctrl-QK. Copy block Ctrl-KC Creates a copy of a marked and displayed block at the current cursor position. The original block is left unchanged, and the markers are placed around the new copy of the block. Move block Ctrl-KV Moves a marked and displayed block from its current position to the cursor's position. The markers remain around the block at its new position. Delete block Ctrl-KY Deletes a marked and displayed block. There is no command to restore a deleted block, so use caution with this command. Hide block Ctrl-KH Toggles on and off the visual marking of a block. Block manipulation commands work only when the block is being displayed. Mark single word Ctrl-KT Marks a single word as a block, combining the functions of the Begin- block and End-block commands. If the cursor is positioned within a word, that word will be marked. If it is not within a word, then the word to the left of the cursor will be marked. And if there is no word to the right of the cursor, then the word to the left will be marked. Read block from file Ctrl-KR Reads a file into the text at the cursor's current position exactly as if it were copied from another part of the text. The file read in is marked as a block. When you use this command, you are prompted for the name of the file to read. If you have used this command earlier in the editing session, the last file name entered will be displayed. You may enter a new file name, make minor changes to the one displayed using the Backspace key, or accept it by pressing [ENTER]. The file specified may be any legal file name, including a drive and/or path identifier. Cancel the command by pressing Ctrl-U. Version 4.0 71 Write block to file Ctrl-KW Writes the currently marked block to a file. The block is left unchanged, and the block markers remain in place. You are first prompted for a filename. The file specified can be any legal file name, including a drive and/or path identifier. You should avoid using file names with the extension .BAK, because this extension is used by the Internal Editor when creating backup files. If the file specified already exists, you are asked if you want to overwrite it. If you press "N" (for NO), you can enter a new file name, make minor changes, or cancel the command with the Ctrl-U command. If no block is marked, this command is ignored. Print Ctrl-KP Prints the currently marked and displayed block on the default printer. If no block is marked or the block is hidden, the entire file is printed. Miscellaneous Commands ______________________________________________________________________ This section describes a number of commands that do not fall into any previous category. Toggle insert mode Ctrl-V or Ins Selects Insert or Overwrite mode. In Insert mode, text to the right of the cursor is moved to the right as new text is entered. In Overwrite mode, any text to the right of the cursor is overwritten when new text is entered. Toggle autoindent Ctrl-QI When Autoindent mode is in effect, the New line command (Enter or Ctrl-M) will move the cursor to the next row and to the same column as the first nonblank character on the previous line. Toggle fixed tabs Ctrl-or When fixed tabs are in effect, the tab stops (normally) start at column 9 and occur every 8 columns thereafter. By default, fixed tabs are off, and smart tabs are on. When smart tabs are in use, the tab stops are determined by the locations of the words on the previous line; the first character in each word represents a tab stop. When fixed tabs are used, the Tab command inserts a single tab character at the cursor's position. When smart tabs are used, the tab is stored as a series of blanks. Restore line Ctrl-QL Undoes any changes made to a line of text as long as you have not left the line. The line is restored to its previous contents regardless of the changes made. Since the Delete line command (Ctrl-Y) moves the cursor to what was previously another line, Restore line cannot recover lines deleted with it. 72 Qmodem Operations Manual Find Ctrl-QF Lets you search for a string of up to 30 characters. When you enter this command, the status line is cleared and you will be asked for a search string. The last search string entered (if any) will be displayed. You can select it again by pressing Enter, edit it, or enter a new string. When editing strings, Backspace deletes the previous character, Ctrl-R restores the previous string, Ctrl-S moves the cursor to the left, and Ctrl-D shows the next character to the right. Esc or Ctrl-U will cancel a search command, and Ctrl-P can be used to enter control characters. After the search string is entered, you must specify your search options. The options you used last, if any, are displayed. Editing works the same as the search string edit. The following options are available: B Searches backwards from the current cursor position toward the beginning of the file. L Limits searches to the currently marked block. n n may be any number. Find the nth occurrence of the search string, counted from the current cursor position. U Ignore case; treats all alphabetic characters as if they were uppercase. W Searches for whole words only; skips matching patterns embedded in other words. If the text contains a target matching the search string, the cursor is positioned at the end of the target. Find and replace Ctrl-QA This operation works the same as the Find command, except that you can replace the "found" string with any other string of up to 30 characters. After entering the search string, you are asked to enter the replacement string. The last replacement string, if any, will be displayed; you can accept it, edit it, or enter a new string. Finally, you are prompted for options. The options you used last are displayed at first. You can enter new options (cancelling the old ones), edit the current options, or select the same options by pressing Enter. The options are the same as those for the Find command with the following exceptions: G Searches globally. The entire file is scanned for the search string, regardless of the current position of the cursor. The search starts at the beginning of the file if searching forward; at the end if searching backwards. Version 4.0 73 N Replaces without asking. Does not prompt for confirmation at each occurrence of the search string. If the text contains a target matching the search string, the cursor is positioned at the end of the target. You are then asked if you wish to replace it. Press "Y" to replace it, or "N" to ignore it. You can abort the operation by pressing Ctrl-U. If you selected the N (no prompting) option, this question will not be asked. You can speed up global search-and-replace operations by selecting the N option and then pressing a key (preferably for a nonprinting character, such as ESC or Ins). The screen is then no longer updated when each replacement is made. Find next Ctrl-L Repeats the last search operation. If the last search command called for a Find operation, the same search string and options will be repeated; for a Find-and-replace operation, the replacement string will be reused as well. Saves the file being edited and exits from the editor. The original file, if any, is renamed to FILENAME.BAK. EDINSTAL - Keyboard Installation Program ______________________________________________________________________ You can use the EDINSTAL program (on the Utilities Disk) to customize the Internal Editor. You can redefine the keystrokes (both primary and secondary) used to invoke the predefined commands. For example, the Toggle fixed tabs command is by default assigned to Ctrl-QI; using EDINSTAL, you could assign this command to Shift-Tab. Running EDINSTAL ______________________________________________________________________ Load EDINSTAL.EXE by typing EDINSTAL at the DOS command line. The QMODEM.EXE file must be in the current directory for this to run. If it is, you will be asked Perform fast entry for fully reconfigured keyboard? If you press "Y" for yes, you can install the keyboard using the fast- entry method. The default response, No, can be given by pressing "N" or Enter. If you answer No, the keyboard will be installed using the random access method. 74 Qmodem Operations Manual Fast Entry ______________________________________________________________________ When you select the fast-entry option, you will see the following instructions: ╔══════════════════════════════════════════════════╗ Press <Enter> to accept default Press keys followed by <Enter> for new key sequence Press <Bksp> to back up one keystroke, C to clear, R to restore Press <Scroll Lock> to toggle literal mode Press <Escape> to quit entering commands Random access editing is available when you are finished ╚══════════════════════════════════════════════════╝ You can then either enter a new key sequence for each command or accept the current one by pressing Enter. Both the command name and the current key sequence are always displayed to the left of the cursor. You specify a new key sequence by pressing the keys you wish to use to invoke that command. Pressing Enter terminates your entry. You can correct mistakes in the current entry by pressing the Backspace key (delete last keystroke), C (Clear entry), or R (Restore previous entry). To specify either the Enter key or a Ctrl-M, you must first press the Scroll Lock key, which indicates that keystrokes are to be interpreted literally; press it again when you've finished entering the key sequence. Pressing Esc stops the fast-entry procedure and takes you to the random access entry screen. Random Access ______________________________________________________________________ When you select the random access option or when you have finished using the fast-entry procedure, you can alter any or all of the default key sequences. The top line of the screen will give you some basic instructions. The remainder of the screen shows (from left to right) the name of the command, the primary key sequence, and the secondary key sequence (if any). Move the cursor to the key sequence you want to change and press Enter. Use the Left arrow and Right arrow keys to select the primary or secondary key sequences, and scroll through the list of commands using the Up arrow, Down arrow, PgUp, and PgDn keys. Home takes you to the first command, and End to the last. You can correct mistakes the same way as the fast-entry edit. Version 4.0 75 Quitting the Program ______________________________________________________________________ When you have finished making changes, press "Q" to quit or "W" to write your changes to the QMODEM.EXE file. If you choose the Write option, you will then see the message "Checking for conflicts..." If you have accidentally assigned the same key sequence to two different commands, an error message will be displayed. You can correct your mistakes by searching for the highlighted items. You will also see an error message if the new list of keystrokes is too large for the area set aside for it. You can easily solve this problem by eliminating a few secondary key sequences. 76 Qmodem Operations Manual The Status Line ______________________________________________________________________ While in terminal mode, Qmodem displays many of its operational settings in the Status Line at the bottom of the screen: ╔════════════════════════════════════════════════╗ 1 2 3 4 5 /-------- 6 --------\ 7 ▒ ANSI Offline 19200-8-N-1 ▒ Home=? ▒ FDX ▒ 8 LF X B M CP LG ^ PR ▒ 13:47:06 ▒ ╚════════════════════════════════════════════════╝ NOTE: Some of the special characters used in the status line are unprintable and may cause erratic printer behavior. These characters were changed to insure proper printing. The status line is divided into seven areas, from left to right: Area 1: The terminal emulation in effect. In the above example, ANSI emulation is active. Area 2: The Online/Offline indicator. When connected to another computer, the word "Online" will be displayed in this area. When Qmodem is first started, this indicator should read "Offline". Area 3: The current communication parameters: Baud Rate, Data Bits, Parity, and Stop Bits. These values will change to reflect changes made with the Alt-P command, or to reflect the values defined in the Dialing directory for each number. Area 4: A short reminder to press the Home key to view the Main Help Menu, which shows all available commands. Summary help on any Qmodem command may be obtained directly from the Main Menu as well. Version 4.0 77 Area 5: The current Duplex (a.k.a. Echo) state. FDX stands for Full Duplex and HDX stands for Half Duplex. Refer to the Alt-E command for a full explanation of Duplex mode. Area 6: The current state of Qmodem Toggles. There are 9 toggles, from left to right: 8 Hi-bit strip toggle. A "7" means that the high bits are stripped, and an "8" means all bits are used. LF Add Linefeed Toggle. If "LF", a Linefeed will be added to all incoming Carriage Returns. If disabled, this area will be blank. X XON/XOFF toggle. If "X", Xon/Xoff flow control is active. If this area is blank, Xon/Xoff flow control is ignored by Qmodem. B Beeps & Bells Toggle (Shown on-screen as a single musical note). If present, indicates that Qmodem will generate sounds on the PC's speaker when specific conditions are met. If this is blank, Qmodem produces no sounds. M Music Toggle (Shown on-screen as a double musical note). If present, indicates that Qmodem will play ANSI Music if found. If blank, Qmodem will not play ANSI music. CP Capture Buffer Toggle. If present, indicates that text is being captured to a file. If blank, incoming text is not captured. 78 Qmodem Operations Manual LG Session Log Toggle. If present, indicates that the Session LOG is active. If blank, the session LOG is not active. ^ Scroll-back Toggle (Shown on-screen by an up-arrow). If present, Qmodem is capturing incoming data to the scroll-back buffer. If blank, the scroll-back feature is not active. PR Printer Toggle. If present, screen text is also sent to the printer. The last item on the Status Line is the System Clock. When ONLINE, the clock displays Elapsed-Time (the duration of the call). When OFFLINE, the clock displays the time-of-day. Version 4.0 79 The HOME Menu ______________________________________________________________________ Pressing the Home key causes Qmodem to display the following screen, which describes all of Qmodem's available commands : ╔════════════════════════════════════════════════╗ ╒══════════════════════════ C O M M A N D M E N U ═══════════════════════════╕ │ │ │ ─────────────────── BEFORE ─────────────────── ──────── TOGGLES ───────── │ │ Alt-D Phone Directory Alt-G Term Emulation Alt-0 Session Log On/Off │ │ ─────────────────── DURING ─────────────────── Alt-1 Bksp/Del Switch │ │ Alt-C Clear Screen ^Home Capture File Alt-5 Host Mode │ │ Alt-F Execute Script ^End Send BREAK Alt-8 Hi-Bit On/Off │ │ Alt-Q QuickLearn Mode PgUp Upload Files Alt-9 Printer On/Off │ │ Alt-S Split Screen PgDn Download Files Alt-B Beeps and Bells │ │ Alt-T Screen Dump ^PgUp (alternate) Alt-E Half/Full Duplex │ │ Scroll-back ^PgDn PgDn (alternate) Alt-I Program Information │ │ ─────────────────── AFTER ──────────────────── Alt-M ANSI Music On/Off │ │ Alt-H Hang-up Modem Alt-X Exit Qmodem Alt-U Scroll Back On/Off │ │ Alt-Z Xon/Xoff Flow On/Off│ │ ─────────────────── SETUP ──────────────────── Alt-= DoorWay Mode │ │ Alt-A Translate Tables Alt-N Configure Qmodem ShTab CR/CRLF Mode │ │ Alt-J Function Keys Alt-P Change Baud Rate Alt-2 80x25 (EGA/VGA) │ │ Alt-K Change COM Port Alt-4 80x43/50 (EGA/VGA) │ │ ──────────────────── DOS ───────────────────── ─────── COPYRIGHT ──────── │ │ Alt-L Change Drive Alt-V View/Edit File The Forbin Project, Inc. │ │ Alt-O Change Directory Alt-W List Directory Post Office Box 702 │ │ Alt-R DOS Shell Alt-Y Delete a File Cedar Falls, IA 50613 │ │ │ ╘════════════════ Qmodem SST Version 4.0 Compiled Jan 31,1989 ════════F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Select a function, F1 for Help -or- ESC to Exit ▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ The Home Menu is divided into 7 areas: BEFORE Commands you are likely to use before dialing a system such as setting terminal emulation and getting into the dialing directory itself. DURING Commands you are likely to use while online. 80 Qmodem Operations Manual AFTER Commands used to end your online session or exit Qmodem. SETUP Commands used to change Qmodem's operational parameters. DOS Commands which interact with your computer, rather than with the computer you are calling. TOGGLES Commands that activate or deactivate certain Qmodem features . Operating these toggles is usually done by pressing the corresponding key combination. COPYRIGHT Qmodem copyright notice and program licensing and registration information. Notice that the standard Qmodem terminal status line changes when the Home Menu is displayed (see above example) As the Home status line indicates, you can get summary help for any command by pressing [F1], then the desired command key combination. Pressing [ENTER] returns Qmodem to terminal mode. Qmodem updates or replaces the Status Line to reflect the current environment, the function being performed, or the command being executed. Check the Status Line often, it may help you get out of trouble if and when you get stuck! Version 4.0 81 Qmodem Commands ______________________________________________________________________ Qmodem features a wealth of commands, many of them with multiple options, and used for different purposes and under different circumstances. This section of the Qmodem documentation describes all Qmodem commands in detail and -- mostly -- in alphabetical order. Alt-A STRIP/REPLACE TABLE. ______________________________________________________________________ ╔════════════════════════════════════════════════╗ ╒══════ Table Selection ══════╕ │ │ │ Select Table to Edit │ │ │ │ 1 - INPUT │ │ 2 - OUTPUT │ │ │ │ Your Choice ? │ ╘═════════════════════F1 Help═╛ ▒▒▒▒▒ Select the Strip/Replace Translate Table to Edit -or- [ESC] to Exit ▒▒▒▒ ╚════════════════════════════════════════════════╝ Strip/Replace is more commonly known as character translation. Translation may be necessary when communicating with another computer whose ASCII codes (the computer's alphabet) do not match those used by your PC. There are 256 ASCII characters, ranging in value from 0 to 255. Stripping a character causes Qmodem to remove that character from all incoming text data. For example: Some computers use the ASCII value 127 as a back space character, while IBM PC and compatibles use the ASCII value 8. Lack of translation would cause back space characters sent by the remote computer to look like so many little houses, the PC symbol for ASCII 127. To insure proper communications, ASCII 127 characters should be changed to the ASCII 8 which your PC understands. Pressing the Alt-A key combinations displays a screen containing the ASCII values 0 through 127 and their respective translations. Since Qmodem does not perform any character translation by default, all values are the same the first time you use the Alt-A command. 82 Qmodem Operations Manual Above the translate table are the original and translated representations of the current value. Characters which have been translated will appear highlighted until changed back to normal. This is a quick visual cue showing what has been changed. ╔════════════════════════════════════════════════╗ ╒═════════════════════════ INPUT Strip/Replace Table ══════════════════════════╕ │ In Character | | Out Character | | │ │ [ 0- 0] 16- 16 32- 32 48- 48 64- 64 80- 80 96- 96 112-112 │ │ 1- 1 17- 0 33- 33 49- 49 65- 65 81- 81 97- 97 113-113 │ │ 2- 2 18- 18 34- 34 50- 50 66- 66 82- 82 98- 98 114-114 │ │ 3- 3 19- 0 35- 35 51- 51 67- 67 83- 83 99- 99 115-115 │ │ 4- 4 20- 20 36- 36 52- 52 68- 68 84- 84 100-100 116-116 │ │ 5- 5 21- 21 37- 37 53- 53 69- 69 85- 85 101-101 117-117 │ │ 6- 6 22- 22 38- 38 54- 54 70- 70 86- 86 102-102 118-118 │ │ 7- 0 23- 23 39- 39 55- 55 71- 71 87- 87 103-103 119-119 │ │ 8- 8 24- 24 40- 40 56- 56 72- 72 88- 88 104-104 120-120 │ │ 9- 9 25- 25 41- 41 57- 57 73- 73 89- 89 105-105 121-121 │ │ 10- 10 26- 26 42- 42 58- 58 74- 74 90- 90 106-106 122-122 │ │ 11- 11 27- 27 43- 43 59- 59 75- 75 91- 91 107-107 123-123 │ │ 12- 0 28- 28 44- 44 60- 60 76- 76 92- 92 108-108 124-124 │ │ 13- 13 29- 29 45- 45 61- 61 77- 77 93- 93 109-109 125-125 │ │ 14- 14 30- 30 46- 46 62- 62 78- 78 94- 94 110-110 126-126 │ │ 15- 15 31- 31 47- 47 63- 63 79- 79 95- 95 111-111 127- 0 │ │ │ │ │ │ │ ╘══════════════════════════════════════════════════════════════════════F1 Help═╛ ▒▒▒▒▒ [] Movement [S]wap [SpaceBar] Change [F10] Save [ESC] Exit ▒▒▒▒ ╚════════════════════════════════════════════════╝ To change (translate) an incoming ASCII value: 1. Move the half-box cursor to the desired ASCII value/character you want to strip or replace. The number to the left of the dash is the original ASCII value; the number on the right is the translated character which you will see when the original character is received. 2. Press the Space Bar once. A prompt will appear at the bottom of the screen asking for an number between 0 and 255. To strip the character, replace the number on the right with a 0 (ZERO). 3. Press [ENTER] to complete the change. Version 4.0 83 The original ASCII specification was a 7-bit code allowing for 128 characters (0-127). All modern-day computers add an 8th bit in front of the original 7 to allow another 128 characters. This 8th bit is also referred to as the High Bit. Pressing the 'S' key will alternate the translate table display between the lower 128 (0-127) and higher 128 (128-255) characters. Note that although a standard exists for most lower ASCII characters, this is not true of the upper 128 values. These High-Bit values are assigned freely by each computer manufacturer. For example, Apple, IBM, and Commodore use radically different standards in assigning characters to these higher values (the IBM PC uses the high-bit values for the international character set, symbols, and line/box-drawing characters). When you are finished, press [F10] to save the changes (if any) or [ESC] to abort the changes and return to the Qmodem terminal screen. Alt-B BELLS AND BEEPS TOGGLE. ______________________________________________________________________ Qmodem uses the PC's speaker as an audible warning when certain events occur (ie, successful connection, or completion of a file transfer). Since the speaker volume cannot be adjusted, you may wish to turn it off. You can toggle the noise on and off with Alt-B. Pressing Alt-B displays the following status window: ╔════════════════════════════════════════════════╗ ╒═════ Status ══════╕ │ Beeps & Bells OFF │ ╘═══════════════════╛ ╒═════ Status ══════╕ │ Beeps & Bells ON │ ╘═══════════════════╛ ╚════════════════════════════════════════════════╝ 84 Qmodem Operations Manual Alt-C CLEAR SCREEN. ______________________________________________________________________ This command clears the screen of all information and resets default colors; a very useful feature. For example, those ANSI color screens displayed on certain Bulletin Boards can utterly mess up your screen colors -- like leaving your screen black-on-black, which is hard to read --. Using Alt-C will reset the color on your screen back to your configuration selections; a real lifesaver. NOTE: If screen colors were changed while executing a Script command, the new screen colors will only remain in effect until the script terminates. Once the Script has ended, default Qmodem colors are restored (but may require an Alt-C to invoke them). NOTE: In VT100 emulation mode, Alt-C only clears the active screen area between the top and bottom margins. This area is referred to as the Scrolling Region. Alt-D DIALING DIRECTORY. ______________________________________________________________________ The Qmodem Dialing Directory can hold up to 200 entries, each containing information such as: name, number, communications parameters, auto-logon script name, date of last connect, total connections, default transfer protocol, and duplex mode. New with Qmodem 4.0 is the ability to have Note Files attached to each directory entry. This file is a standard ASCII text file intended to hold any and all information relating to that entry: information about the System being called, hours of operation, Sysop name, etc... The size of this text file is limited only by the amount of memory allocated to the Qmodem Internal Editor as defined via Alt-N/O/M/E (remember back in the installation section?) Entries with attached Note Files are identified in the Dialing Directory with a triple-bar symbol immediately following the entry's number. Entry #1 in the following snapshot has an attached Note File. Version 4.0 85 After pressing Alt-D, the following screen is displayed: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Phone Book ═════════════════════════════════╕ │ Page 1 of C:\QMODEM\QMODEM.FON │ │ Total Tags > 2 Prefixes > ABC │ │[D] Name Number COM Script │ │1 ≡ Forbin Project BBS 1-319-233-6157 19200-8-N-1 SYSOP2.SCR │ │2 19200-8-N-1 │ │3 19200-8-N-1 │ │4 19200-8-N-1 │ │5 19200-8-N-1 │ │6 19200-8-N-1 │ │7 GEnie_Local 1200 Baud `B555-1212 1200-8-N-1 GENIE │ │8 19200-8-N-1 │ │9 ≡ Sound of Music V9600 `A1-301-555-1212 19200-8-N-1 MUSIC! │ │10 √ LANS Node 1 HST 1-219-555-1212 19200-8-N-1 LANS │ ╞══════════════════════════════════ Commands ══════════════════════════════════╡ │ Entries Dial FON │ │ SPACE - Tag/Untag ENTER - Starts Dialing F - Find Text │ │ C - Clear Tagged ESC - Cancel/Exit A - Find Again │ │ E - Edit Prefixes M - Manual Dial L - Load │ │ Q - QuickLearn O - Other Info │ │ R - Revise Edit P - Print │ │ T - Tag Multiple N - Attached Note S - Sort │ │ U - Untag All V - Linked Script ^U - Undo │ ╘════════════════════════════════════════════════════════════════════F1 Help═══╛ ▒▒▒▒ Move Bar : PgUp PgDn ^PgUp ^PgDn [ENTER] to Dial [ESC] to Exit ▒▒▒ ╚════════════════════════════════════════════════╝ The Dialing Directory screen is divided into 2 sections: The upper section displays directory entries, the current page, the number of tagged entries (more on this in a moment), the number of pre-defined Dialing Prefixes, and the actual entries on the page. The lower screen section displays all available Dialing Directory commands. TIP: If your PC has EGA or VGA display capabilities, or is able to display at least 43 lines on the screen, the directory will display an additional 10 lines entries per screen! What this snapshot does not show is the scrollbar cursor, a screen- wide highlight identifying the current directory entry. Instructions on moving the scrollbar cursor are shown in the Alt-D status line. 86 Qmodem Operations Manual Moving around in the Directory Up/Down - PgUp/PgDn - ^PgUp/^PgDn ______________________________________________________________________ The Up and Down arrow keys move the scrollbar cursor one line at a time in the corresponding direction. Pressing PgDn displays the next directory page -- unless the last page is displayed --. Pressing PgDn while in the last directory page causes wrap around back to the first directory page. The same principle applies to the PgUp key, but in the opposite direction of course.. ^PgUp will position the scrollbar cursor to the FIRST entry in the directory (#1), while ^PgDn positions the cursor at the LAST entry (#200). Entries Spacebar - Tagging entries ______________________________________________________________________ Tagging of Dialing Directory entries is a new feature in Qmodem 4.0. A number of Dialing Directory commands operate on tagged entries. Therefore, it is important to understand WHAT tagging is. We will then be able to describe how it is done. Basic Dialing Directory commands such as Revise, Clear, and Dial, act only on entries that are tagged. To add multiple new entries to the phone book, blank lines are first tagged, then enter the new information, one entry at a time. Clearing (removing) entries works in a similar fashion. You first tag the entries to be cleared, then select the Clear option. To build a dialing queue, tag the desired entries, and press [ENTER]. As you will see, there are many methods to accomplish the same things, each having its advantages or drawbacks. The rest of the commands are there to make Qmodem easier to use. There are three methods used to tag entries; Pressing the Space Bar, the 'Q' key, and a third method called implied tagging. The Space Bar is the most commonly used tagging method. Q-tagging will be briefly discussed here, but will be covered in more detail later on. Implied tagging will be discussed under the CLEARING ENTRIES heading. Tagged entries are identified by Qmodem in two different ways: 1. They are displayed in a different color (provided your color setup defines them as such), and 2. They are preceded by the special check-mark character '√' or 'Q'. The previous screen snapshot shows entry #10 as being tagged. Version 4.0 87 What is the difference between the '√' and 'Q' tags? Good question. If the Script field is blank or contains a Script name and the Script exists, then the '√' tag is used. If a Script name is specified for that entry, but the script file does not exist, the letter 'Q' is used as a tag character instead. "So why the letter 'Q', anyway?" Another good question. 'Q' stands for "QuickLearn", Qmodem's automatic script-building facility. As the connection is established, QuickLearn records your interaction with the remote computer and creates a Script file which exactly replicates these actions the next time you call. As a result, the logon process becomes automated -- fast and painless --. A complete description of the QuickLearn facility is included later on in this manual. We think that QuickLearn sure beats a poke in the eye with a sharp stick. It is a neat feature, well worth paying for. "I now have entries tagged... now what?" Now you can Dial them, Revise them, or Clear them! TIP: Un-tagging an entry is as simple as tagging it; use the Space Bar again. With the cursor on a tagged entry, pressing the Space Bar removes the tag. C - Clearing Entries ______________________________________________________________________ Clearing multiple entries requires that they first be tagged. Does this mean that you must tag a single entry before you revise or clear it? No, not quite. If there are no tagged entries, Qmodem assumes that the command applies to the entry at the cursor. Internally, Qmodem tags the current entry, then executes the requested command. This is the implied tagging method mentioned earlier, which requires no specific tagging action on your part. Thus, to perform operations against single entries, you do nothing more than issue the command; Qmodem does the rest. To clear a single entry, move the scrollbar cursor to it, and press C. Implied tagging cannot be used when multiple entries are tagged explicitly. To clear multiple entries, tag them first with the Space Bar, then press C. The scrollbar cursor will move to the first tagged entry and Qmodem will display the Clear Entry menu. CAUTION: If multiple entries are already tagged as the result of a previous operation (ie, dialing), and you wish to 88 Qmodem Operations Manual clear a single entry, REMOVE ALL TAGS first by typing 'U'. Since tagged entries may be elsewhere in the directory, and not visible in the current page, it is easy to assume that implied tagging will work, when in fact it will not. It is advisable to check the Tag Count displayed at the top of the dialing directory screen before attempting any "implied-tag" commands. Now that you understand the difference between explicit and implicit tagging, let's look at an example. In the screen below, entry #5 was tagged, and 'C' was pressed: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Phone Book ═════════════════════════════════╕ │ Page 1 of C:\QMODEM\QMODEM.FON │ │ Total Tags > 2 Prefixes > ABC │ │[D] Name Number COM Script │ │1 ≡ Test Node at Forbin 555-1212 19200-8-N-1 SYSOP2.SCR │ │2 Forbin Project Main Number 233-6157 19200-8-N-1 FORBIN │ │3 19200-8-N-1 │ │4 19200-8-N-1 │ │5 ≡√ Old BBS to delete 555-1212 9600-8-N-1 │ │6 19200-8-N-1 │ │7 GEnie_Local 1200 Baud `B277-4741 1200-8-N-1 GENIE │ │8 19200-8-N-1 │ │9 ≡ Sound of Music ╒══ Clear Entries and/or Notes ══╕00-8-N-1 MUSIC! │ │10 LANS Node 1 │ │00-8-N-1 LANS │ ╞═══════════════════════│ 1. Notes Only │═════════════════════╡ │ Entries │ 2. Entries & Notes │ FON │ │ SPACE - Tag/Untag │ ESC. Return to Directory │ F - Find Text │ │ C - Clear Tagge│ │ A - Find Again │ │ E - Edit Prefix│ Your Choice ? _ │ L - Load │ │ Q - QuickLearn ╘════════════════════════F1 Help═╛ O - Other Info │ │ R - Revise Edit P - Print │ │ T - Tag Multiple N - Attached Note S - Sort │ │ U - Untag All V - Linked Script ^U - Undo │ ╘════════════════════════════════════════════════════════════════════F1 Help═══╛ ▒▒▒▒ [1] Clear Attached Notes [2] Clear Entries and Notes [ESC] Abort ▒▒▒▒ ╚════════════════════════════════════════════════╝ The Clear Entry window serves a dual purpose. It can clear Attached Notes from an entry, or it can clear both the Notes and the entry itself. Entries cannot be deleted without Attached Notes being deleted also. In the example above, entry #5 has an attached Note. Selecting option #2 from the menu would delete the Note file as well as clear the entry. If entry #5 did not have an attached Note and we selected Clear Option #1, no action would be taken. Version 4.0 89 CAUTION: The menu option you select is applied to ALL tagged entries -- IE: clear all tagged entries, or clear all their attached notes --. To clear "Notes only" from certain tagged entries cannot be done and requires a separate operation. The complete Phone Book is backed up prior to clearing entries; the Note files are not. Once Attached Notes are cleared, they cannot be restored. E - Edit Prefixes ______________________________________________________________________ Prefix characters are used at the beginning or end of phone numbers -- or anywhere inbetween -- to add standard and repetitive dialing information to the numbers as they are dialed. A prefix may be as simple as "Dial 9 to get out" or "Dial 1 for long distance", or it may hold a 7-digit SPRINT or MCI local access number. When used at the end of a number, the prefix becomes a Suffix which may be used to store a PBX access code, for example. In special cases, prefixes may even be used to store Alternate Dialing Commands. 90 Qmodem Operations Manual Pressing 'E' displays the Prefix edit window: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Phone Book ═════════════════════════════════╕ │ Page 1 of C:\QMODEM\QMODEM.FON │ │ Total Tags > 2 Prefixes > ABCEF │ │[D] Name Number COM Script │ │1 ≡ Test Node at Forbin EF555-1212 19200-8-N-1 SYSOP2.SCR │ │2 ╒══════════ Edit Prefixes ══════════╕9200-8-N-1 FORBIN │ │3 │ A ATDT░░░░░░░░░░░░░░░░░░░░░░░░░░ │9200-8-N-1 │ │4 │ B AT&M0DT░░░░░░░░░░░░░░░░░░░░░░░ │9200-8-N-1 │ │5 │ C AT&M4DT░░░░░░░░░░░░░░░░░░░░░░░ │9200-8-N-1 │ │6 │ D ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │9200-8-N-1 │ │7 GEnie_Local │ E 555-1212,,░░░░░░░░░░░░░░░░░░░░ │1200-8-N-1 GENIE │ │8 │ F 1234567,░░░░░░░░░░░░░░░░░░░░░░ │9200-8-N-1 │ │9 ≡ Sound of Mus│ G ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │9200-8-N-1 MUSIC! │ │10 LANS Node 1 │ H ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │9200-8-N-1 LANS │ ╞══════════════════│ I ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │═══════════════════════╡ │ Entrie│ J ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ FON │ │ SPACE - Tag/Un╘════════════════════════════F1 Help╛ F - Find Text │ │ C - Clear Tagged ESC - Cancel/Exit A - Find Again │ │ E - Edit Prefixes M - Manual Dial L - Load │ │ Q - QuickLearn O - Other Info │ │ R - Revise Edit P - Print │ │ T - Tag Multiple N - Attached Note S - Sort │ │ U - Untag All V - Linked Script ^U - Undo │ ╘════════════════════════════════════════════════════════════════════F1 Help═══╛ ▒▒▒▒▒▒ Select a Prefix character to Edit. [F10] to Save [ESC] to Abort ▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ Qmodem allows up to 10 Prefix codes, assigned the letters 'A' through 'J'. Each prefix code can store up to 30 characters. In the example above, 5 Prefix codes have been defined. Also note that the phone number for entry #1 contains codes 'E' and 'F'. You can use multiple Prefix codes in any position of the Number field. CAUTION: DO NOT define a phone number using its Alpha representation. Numbers such as "1-800-DECDEMO" may be a valid telephone number, but Qmodem will substitute the prefix values of letters 'A'-'J' in any phone number. For all we know, 1-800-DECDEMO might get you connected with Outer Mongolia ($98.55 a minute). Version 4.0 91 NOTE: Make sure that the total length of the dialed number AND prefix(es) does not exceed your modem's maximum command length. This maximum should be listed in your modem's operation manual. Most modems limit dialing input to 40 characters. If you have a Hayes-compatible modem, you will notice that Prefix codes 'A', 'B', and 'C' look amazingly similar to the Modem Dialing Command defined in Alt-N/M/M/P. That's because these prefixes are dialing commands. To use these alternate dialing commands, precede the desired prefix with the special character ` (left tick mark or single end quote). When Qmodem detects that special character, it will use the prefix code which immediately follows instead of the Alt-N default dialing command. Example: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Phone Book ═════════════════════════════════╕ │ Page 1 of C:\QMODEM\QMODEM.FON │ │ Total Tags > 2 Prefixes > ABCEF │ │[D] Name Number COM Script │ │1 ≡ Non-existent Number `A555-1212 19200-8-N-1 SYSOP2.SCR │ │2 Forbin Project Main Number `C1-319-233-6157 19200-8-N-1 FORBIN │ │3 Another Number not to call `B555-1212 19200-8-N-1 │ │4 19200-8-N-1 │ ╚════════════════════════════════════════════════╝ The example above assumes a USRobotics Courier HST modem. The HST's MNP error-correction mode is enabled with the AT&M4 command, and it is disabled with the AT&M0 command. The DT "Dial Tone" command tells the modem to tone-dial the number which follows. In the example above, entry #2 will be dialed with an AT&M4DT command, which enables MNP error-correction and dials the Forbin Project (which operates a few HST modems). . Entry #3 will be dialed with an AT&M0DT command, which disables MNP error-correction and dials 555-1212. Entry #1 will be dialed with a standard ATDT command which will not affect the current state of MNP error correction. 92 Qmodem Operations Manual TIP: If you use the ` modifier to enable or disable one or more of your modem's features, be sure to set the default dialing prefix (Alt-N/M/M/P) to the mode which you use most often. By doing this, you only need to override entries that do not conform to the default mode. In the previous example, your default dialing prefix should be "AT&M4DT". Prefix `B would be used to dial non-MNP systems. Q - QuickLearn ______________________________________________________________________ Pressing 'Q' toggles the QuickLearn tag for the current entry if the Script field is non-blank. Connecting to a Q-tagged entry activates the QuickLearn Script Recorder. TIP: You can force QuickLearn by using the letter 'Q' to tag the entry instead of the SPACEBAR. When you connect, QuickLearn starts rewriting the Script for you! Qmodem's QuickLearn feature is described in detail under the Alt-Q command. Version 4.0 93 R - Revise ______________________________________________________________________ The Revise command is used to edit Dialing Directory entries. Since all 200 entries already exist in the directory, adding and entry consists of editing a blank one. Multiple entries can be revised sequentially if they are previously tagged. If no entries are tagged, pressing 'R' will cause revision of the current entry (implicit tagging). If multiple entries are tagged, pressing 'R' will position the cursor to the first tagged entry and will display the revision window: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Phone Book ═════════════════════════════════╕ │ Page 1 of C:\QMODEM\QMODEM.FON │ │ Total Tags > 2 Prefixes > ABC │ │[D] Name Number COM Script │ │1 ≡ Forbin Project BBS 1-319-233-6157 19200-8-N-1 SYSOP2.SCR │ │2 ╒═════════════ Revise Entry ══════════════╕-N-1 FORBIN │ │3 │ Name Forbin Project BBS░░░░░░░░░ │-N-1 │ │4 │ nUmber 1-319-233-6157░░░░░ │-N-1 │ │5 │ Password MYPassword░░░░ │-N-1 │ │6 │ Script Forbin░░░░░░ │-N-1 │ │7 GEnie_Local │ Baudrate 19200 │-N-1 GENIE │ │8 │ Databits 8 │-N-1 │ │9 ≡ Sound of Mus│ pArity None │-N-1 MUSIC! │ │10 √ LANS Node 1 │ sTopbits 1 │-N-1 LANS │ ╞══════════════════│ dupLex F │═════════════════╡ │ Entrie│ pRotocol F │ FON │ │ SPACE - Tag/Un│ lastCall 10-11-88 │ Find Text │ │ C - Clear │ tiMes on 1021 │ Find Again │ │ E - Edit P╘══════════════════════════════════F1 Help╛ Load │ │ Q - QuickLearn O - Other Info │ │ R - Revise Edit P - Print │ │ T - Tag Multiple N - Attached Note S - Sort │ │ U - Untag All V - Linked Script ^U - Undo │ ╘════════════════════════════════════════════════════════════════════F1 Help═══╛ ▒▒▒▒▒▒▒▒▒▒▒▒ Change the NAME field [F10] to Save [ESC] to Abort ▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ The Revise Entry menu is similar to the menus used in Alt-N commands. To change a field, move the cursor to it or type the highlighted letter displayed in the field's name and press [ENTER]. This activates the Qmodem field editor and you may type the desired information. Second-level menus are displayed for Baudrate and Parity; to select the appropriate setting cursor to it and press [ENTER]. 94 Qmodem Operations Manual Once you have completed the revisions, press [F10] to save the changes. In the unlikely event you made a mistake, pressing [ESC] will restore the field's original value. When revising multiple tagged entries, the Revise Menu will display the entries one at a time, in ascending numeric sequence. As each entry is saved (or you exit the Revise Menu via [ESC]), the next entry will be displayed, until all tagged entries have been processed. T - Tag Multiple ______________________________________________________________________ Tag Multiple is used to tag entries based on their entry number or the text content of their Name, Number field, or Attached Note file. In addition, Tag Multiple can be used to add or delete Prefix codes from entries' phone numbers. Pressing 'T' will display a small prompt window in the Command area: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Phone Book ═════════════════════════════════╕ │ Page 1 of C:\QMODEM\QMODEM.FON │ │ Total Tags > 2 Prefixes > ABC │ │[D] Name Number COM Script │ │1 ≡ Forbin Project BBS HST 1-319-233-6157 19200-8-N-1 SYSOP2.SCR │ │2 Forbin BBS Hayes V9600 node 1-319-233-6006 19200-8-N-1 FORBIN │ │3 19200-8-N-1 │ │4 19200-8-N-1 │ │5 19200-8-N-1 │ │6 19200-8-N-1 │ │7 GEnie_Local 1200 Baud `B555-1212 1200-8-N-1 GENIE.SCR │ │8 19200-8-N-1 │ │9 ≡ Sound of Music V9600 `A1-301-555-1212 19200-8-N-1 MUSIC! │ │10 LANS Node 1 HST 1-219-555-1212 19200-8-N-1 LANS │ ╞══════════════════════════════════ Commands ══════════════════════════════════╡ │ Entries Dial FON │ │ SPACE - Tag/Untag ENTER - Starts Dialing F - Find Text │ │ C - Clear Tagged ESC - Cancel/Exit A - Find Again │ │ ╒═══════════════════════════ Select Entries ════════════════════════════╕ │ │ │ Numbers to TAG > ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ │ │ ╘═══════════════════════════════════════════════════════════════════════╛ │ │ T - Tag Multiple N - Attached Note S - Sort │ │ U - Untag All V - Linked Script ^U - Undo │ ╘════════════════════════════════════════════════════════════════════F1 Help═══╛ ▒▒▒▒ Enter line #'s, P[prefixes]#[suffixes], T[text] -or- [ESC] to Abort ▒▒▒ ╚════════════════════════════════════════════════╝ Version 4.0 95 Let's review the options displyed on the status line. "Enter line #'s" Used to tag entries based on their number in the directory. To tag entries 1, 22, 23 and 40, you would type: ╔══════════════════════════════════════════════════╗ ╒═══════════════════════════ Select Entries ════════════════════════════╕ │ Numbers to TAG > 1 22 23 40░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ ╘═══════════════════════════════════════════════════════════════════════╛ ╚══════════════════════════════════════════════════╝ This feature is reminiscent of earlier releases of Qmodem which prompted the user for the numbers to be dialed. With Qmodem 4.0, you must politely ask for the prompt by pressing T. We did not forget loyal Qmodem users and this feature may help you get over the Qmodem 4.0 Culture Shock -- until you learn that tagging is THE ONLY way to go, of course --. "P[prefixes]#[suffixes]" A prefix or suffix may be added to, changed, or deleted from an entry's phone number by preceding that entry's number with the letter 'P'. For example, to dial entry #1 AND to add the prefix modifier 'A' to the beginning and 'B' to the end of the number, you would type: ╔══════════════════════════════════════════════════╗ ╒═══════════════════════════ Select Entries ════════════════════════════╕ │ Numbers to TAG > PA1B░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ ╘═══════════════════════════════════════════════════════════════════════╛ ╚══════════════════════════════════════════════════╝ The 'P' modifier tells Qmodem that one or more prefix codes will precede or follow the entry number, and that these are to be added to the entry's phone number. In the example above, the prefix 'A' is added before the number, and 'B' following it: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Phone Book ═════════════════════════════════╕ │ Page 1 of C:\QMODEM\QMODEM.FON │ │ Total Tags > 1 Prefixes > ABC │ │[D] Name Number COM Script │ │1 ≡ Forbin Project BBS HST A1-319-233-6157B 19200-8-N-1 SYSOP2.SCR │ ╚════════════════════════════════════════════════╝ 96 Qmodem Operations Manual To REMOVE Suffix 'B' from entry #1, we would type: ╔══════════════════════════════════════════════════╗ ╒═══════════════════════════ Select Entries ════════════════════════════╕ │ Numbers to TAG > PA1░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ ╘═══════════════════════════════════════════════════════════════════════╛ ╚══════════════════════════════════════════════════╝ Since the 'A' prefix is kept, it is typed. 'B' was not included, so the 'B' suffix is removed. Taking this one step further, to remove ALL prefixes/suffixes from entry #1, we would type: ╔══════════════════════════════════════════════════╗ ╒═══════════════════════════ Select Entries ════════════════════════════╕ │ Numbers to TAG > P1░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ ╘═══════════════════════════════════════════════════════════════════════╛ ╚══════════════════════════════════════════════════╝ "T[text]" Allows tagging of entries based based on a text search of the entries': 1. NAME field, 2. NUMBER field, and 3. Attached NOTE files Each text string to be searched is preceded by the letter 'T'. Using the previous phone book example, let's tag all the entries in the 319 area code, as well as those using V9600 modems (we kept the modem information in the Attached Note Files): ╔══════════════════════════════════════════════════╗ ╒═══════════════════════════ Select Entries ════════════════════════════╕ │ Numbers to TAG > T319 tV9600░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ ╘═══════════════════════════════════════════════════════════════════════╛ ╚══════════════════════════════════════════════════╝ Entries 1,2 and 9 would be tagged. NOTE: The leading 'T' is not case sensitive and text search arguments MUST be separated by at least one space. Version 4.0 97 NOTE: Text search arguments may not contain imbedded spaces. The space, the letter 'T', and the end of the prompt line are text search delimiters. A Qmodem Beta tester asked, "I entered the following command, but not all the numbers were tagged. Why?" ╔══════════════════════════════════════════════════╗ ╒═══════════════════════════ Select Entries ════════════════════════════╕ │ Numbers to TAG > 1 to 200░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ ╘═══════════════════════════════════════════════════════════════════════╛ ╚══════════════════════════════════════════════════╝ Well, Qmodem isn't quite that smart yet. Maybe in a future release... However, here is how Qmodem interpreted that command: 1. Tag entry number 1. 2. Search for the text 'o' in the Name, Number and Note files. 3. Tag entry number 200. Since the letter 'o' is fairly common (right Vanna?) 90% or more of the entries would end up tagged. Entries 1 and 200 were explicitly asked for, and were tagged. Tag Multiple is a powerful tool in the Alt-D arsenal. U - Untag All ______________________________________________________________________ Pressing 'U' will remove all tags in the directory. NOTE: When you are about to use an "Implied Tag" command on the current entry, make sure other entries are not tagged (the tag count is displayed at the top of the directory screen). If entries are tagged, you may want to use Untag All to remove the tags before proceeding with the command. 98 Qmodem Operations Manual Dial ENTER - Starts dialing ______________________________________________________________________ Pressing [ENTER] will begin dialing tagged entries in numerical order starting from the current scrollbar position. If no entries are tagged, the current entry will be tagged and dialed immediately. The Redialer will cycle through the tagged entries until a connection is made or you press [ESC] to halt the process. NOTE: Qmodem will not dial entries with blank phone numbers. The information in the number field is not checked for validity. The Dial/Redial window has been refined for version 4.0. Although similar to previous releases of Qmodem, the information displayed has been re-arranged to make it easier to track your progress. ╔════════════════════════════════════════════════╗ ╞══════════════════════════════════ Redialer ══════════════════════════════════╡ │ │ │ Name : Forbin Project PCBoard Last On : 12-01-88 │ │ Number : 1-319-233-6157 Total # : 807 │ │ Script : FORBIN.SCR Attempt : 1 │ │ │ │ Modem : ATDT1-319-233-6157 Start : 10:26:23 │ │ Status : 45 Seconds remain until Cycle Current : 10:26:23 │ │ │ ╘══════════════════════════════════════════════════════════════════════════════╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒ [C]ycle [K]ill [X]tend Timer -or- [ESC] to Exit ▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ The Qmodem Dialer screen is divided into four areas, each containing information relating to the call in progress and to the entry being dialed: The upper left screen quadrant identifies the dialed entry by name and phone number, and the name of the attached Script, if any. The lower left screen quadrant tracks the commands sent to the modem and the responses received from it. The status line displays timely information on the call in progress. The upper right screen quadrant displays the date of last connect, the total number of successful connections to the entry being dialed, and the number of dialing attempts during the current session. The lower right screen quadrant displays the time at which the dialing session was started, as well as the current time of day. Version 4.0 99 While in the dialer window, the following commands are valid: [C]ycle Pressing 'C' cancels the current call and start dialing the next tagged entry. [K]ill Pressing 'K' cancels the current call and untags it, effectively removing it from the dialing queue. [X]tend Timer Pressing 'X' key increases the dial cycle delay by 5 seconds. The cycle delay is the amount of time Qmodem waits for a connection before dialing the next entry (or the same entry if only one is being called). This delay is defined in the Alt-N/M/C/H setup menu. [ESC] Pressing ESC cancels the current call and exits the dialer. Explicitly tagged entries remain tagged. Status Messages ______________________________________________________________________ The Status message area in the lower left screen quadrant reports messages from the modem and the dialer. Modem messages are returned in response to dialing commands and may include codes such as BUSY, NO CARRIER, VOICE, etc... NOTE: Extended responses such as BUSY, VOICE, and RINGING may not be implemented by your particular modem. Check your modem manual to determine which return codes are available. Modem responses are defined in the Alt-N/M/M setup menu. The Dialer may return the following status messages: Manual Cycle You pressed 'C' to Cycle. 100 Qmodem Operations Manual Number has been un-tagged 'K' was pressed to remove the entry. ESC pressed, Dialing aborted [ESC] was pressed, and you are returned to Command mode. Dial timing period expired The cycle delay expired before a connection was made. Line busy or modem timed out One of the 4 modem Error messages (Alt-N/M/M) was returned and the call was cancelled. CONNECTED, press a key to continue The modem returned the Connect message (Alt-N/M/M/C) and is now online. If the entry has an attached script, this message will be immediately erased, Qmodem will exit the dialer, and control will be passed to the script. If no script is attached to the entry, press any key to return to the Qmodem terminal screen to view the online session. Redial pausing XXX The previous attempt was unsuccessful and the dialer is waiting before placing the next call. Dialing halted. Incoming call detected The Redial Cancel message (Alt-N/M/M/R) was received between dial attempts, indicating that a call is being received at the same time dialing is attempted. XXX Seconds remain until Cycle The current call is in progress. After XXX seconds, the call will be cancelled if a connection is not established. The original delay is specified in the Alt-N/M/C/H setup menu. Version 4.0 101 NOTE: Most modems have an internal timer which will cause the unit to hang up after waiting for a specific time for a connection to be made (most have a 60 second default). If the modem hangs up before the Qmodem delay expires, your modem's delay is shorter than the Qmodem Alt-N/M/C/H setting. It is recommended to set the modem's delay to a value high enough not to conflict with the Qmodem setting. Parameters passed to the Linked Scripts ______________________________________________________________________ Prior to passing control to a linked script, Qmodem updates the values in the following pre-assigned string variables: $BOARD - the name of field. $NUMBER - the number called. $SPEED - the current baud rate. $COM - the parity, data and stop bits. $PASSWORD - the password field. $PROTOCOL - the default transfer protocol. $SCRIPT - the name of the linked script. $NOTEFILE - the name of the attached Note file. These variables remain in effect for the duration of the script. For more information on scripts and string variables, refer to the Script Language Section in this manual. ESC - Exit Dialing Directory ______________________________________________________________________ Pressing [ESC] will exit the dialing directory and return Qmodem to the terminal screen. Any entries that were tagged will remain tagged. 102 Qmodem Operations Manual M - Manual Dial ______________________________________________________________________ When a number is not in the dialing directory, it can be dialed manually. Pressing 'M' displays the Manual Dial window: ╔════════════════════════════════════════════════╗ ╞══════════════════════════════════ Commands ══════════════════════════════════╡ │ Entries Dial FON │ │ SPACE - Tag/Untag ENTER - Starts Dialing F - Find Text │ │ C - Clear Tagged ESC - Cancel/Exit A - Find Again │ │ E -╒═════════════════ Manual Dial ══════════════════╕ Load │ │ Q -│ Phone number > ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ Other Info │ │ R -╘════════════════════════════════════════════════╛ Print │ │ T - Tag Multiple N - Attached Note S - Sort │ │ U - Untag All V - Linked Script ^U - Undo │ ╘════════════════════════════════════════════════════════════════════F1 Help═══╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒ Enter the phone number to call -or- [ESC] to Abort ▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ Manual dial commands may contain up to 30 characters and/or digits. The number is not checked for validity; the data typed in the Phone Number field will be passed to the modem unchanged. Edit N - Attached Notes ______________________________________________________________________ Textual information can be "Attached" to each directory entry and retrieved with a single keystroke. The data is stored in special Note Files which can be edited with Qmodem's Internal Editor, or any editor of your choice (as defined in Alt-N/F/V). Version 4.0 103 To create a note file, update an existing note, or view one, move the scrollbar cursor to the entry and press 'N'. The Note command is an immediate command and does not affect the tagging of other entries. When you press 'N', the current entry's Note File will be edited. The following example demonstrates the use of the Qmodem Internal Editor: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Phone Book ═════════════════════════════════╕ │ Page 1 of C:\QMODEM\QMODEM.FON │ │ Total Tags > 2 Prefixes > ABC │ │[D] Name Number COM Script │ │1 ≡ Test Node at Forbin 555-1212 19200-8-N-1 SYSOP2.SCR │ │2 Forbin Project Main Number 233-6157 19200-8-N-1 FORBIN │ │3 19200-8-N-1 │ │4 19200-8-N-1 │ │5 19200-8-N-1 │ │6 19200-8-N-1 │ │7 Q GEnie_Local 1200 Baud `B277-4741 1200-8-N-1 GENIE │ │8 19200-8-N-1 │ │9 ≡√ Sound of Music V9600 `A1-900-666-5555 19200-8-N-1 MUSIC! │ │10 LANS Node 1 HST 1-219-884-9508 19200-8-N-1 LANS │ ╒═══════════════════════ Notes for Test Node at Forbin ════════════════════════╕ │ Line 1 Col 1 Insert Indent C:QMODEM.1 │ │NAME: Forbin Project PCBoard BBS │ │DESC: Home of Qmodem, │ │BBS : PCBoard (Alpha test site) │ │BAUD: 1200/2400/9600/19200 │ │MODM: Courier_HST │ │HRS : 24 hrs/day, 7 days/week │ │NETS: InterLink, SmartNet │ ╘══════════════════════════════════════════════════════════════════════F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒ F1-Help F2-Save F3-New F9,ESC-Abort F10-Save & Exit ▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ The internal editor screen overlays the command area at the bottom of the screen. The current entry's name is shown in the editor window's label. The maximum size of a note file is limited by the memory allocated to the Qmodem Internal Editor (defined in Alt-N/O/M/E) or the limit imposed by your own external editor. TIP: In the example above, the note is used to store useful information which cannot be stored into the dialing directory itself. Using this method to document directory entries allows the use of the Text Search function (or a text search argument in a Tag command) to locate entries based on BBS software, the type of modem in use, or supported baud rates. 104 Qmodem Operations Manual The names assigned to Note Files are transparent to the user. These names are assigned permanently when the directory is created. Note files have the same file name as the directory to which they are attached, and their file extension is a number in the range 1..200, corresponding to the entry to which that specific note file is attached. The name of each note file is stored in each directory entry, which allows sorting of the directory without losing the Note File linkage. NOTE: If you upgraded from a previous release of Qmodem, you MUST run the UPGRADE.EXE program included with the new 4.0 release BEFORE you run the Qmodem 4.0 program. Failure to do so will cause unpredictable results because the Note Number was not set. NOTE: If you use an external editor, make sure that is creates standard CR/LF-delimited ASCII files to insure that text search commands work properly. If an entry has an attached Note, a special symbol will be displayed immediately following the entry number in the directory. In the previous example, entries 1 and 9 have attached Notes and the three- bar character is being used. TIP: The Attached Notes identifier can be changed via the Alt-N/O/C setup menu. V - Linked Scripts ______________________________________________________________________ "Linked Scripts" are executed when the connection is established. These are commonly referred to as "Logon Scripts". Pressing 'V' allows editing of linked scripts, much in the same way as the Revise Entry command. The 'V' command operates the same way as the 'N' command in that it is immediate and does not affect the tagging of other entries. When you press 'V', the current entry's linked script will be edited. When editing a linked script, the Qmodem Internal Editor uses the entire screen area. NOTE: The Script field cannot be blank for the editor to be invoked successfully. Version 4.0 105 Following is a sample Linked Script Edit Screen (using the Qmodem Internal Editor, of course): ╔════════════════════════════════════════════════╗ ╒══════════════════════════════ Full Screen Edit ══════════════════════════════╕ │ Line 1 Col 1 Insert Indent E:SYSOP2.SCR │ │; │ │; QuickLearn Script generated at 02:35:18 on 08-22-88 │ │; May require editing before use. │ │; │ │TurnOn 8_BIT │ │TurnOff LINEFEED │ │TurnOn XON/XOFF │ │TurnOff NOISE │ │TurnOff MUSIC │ │TurnOn SCROLL │ │TurnOff PRINT │ │TurnOff ECHO │ │ │ │TimeOut 30 ; Set Waitfor timeout to 30 seconds │ │ │ │Waitfor "want ANSI Graphics (Enter)=no?" │ │Delay 100 │ │Send "n q^M" │ │ │ │Waitfor "What is your first name?" │ │Delay 100 │ ╘══════════════════════════════════════════════════════════════════════F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒ F1-Help F2-Save F3-New F9,ESC-Abort F10-Save & Exit ▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ F - Find Text ______________________________________________________________________ The Find Text command is used to quickly scan the dialing directory for a specific text string. Entry Names, Phone Numbers and Attached Notes are searched starting with entry #1. Following the search, the scrollbar cursor will be positioned on the first matching entry (if any). Unlike the Tag Multiple command, matching entries are NOT tagged. Also, unlike Tag Multiple, you may only specify one search argument. With the Find Text command, search arguments may contain imbedded spaces. 106 Qmodem Operations Manual Pressing 'F' displays the Find Text prompt: ╔════════════════════════════════════════════════╗ ╞══════════════════════════════════ Commands ══════════════════════════════════╡ │ Entries Dial FON │ │ SPACE - Tag/Untag ENTER - Starts Dialing F - Find Text │ │ C - Clear Tagged ESC - Cancel/Exit A - Find Again │ │ E - Edit Pr╒═══════════════ Find Text ════════════════╕oad │ │ Q - QuickLe│ Search for > ░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ther Info │ │ R - Revise ╘══════════════════════════════════════════╛rint │ │ T - Tag Multiple N - Attached Note S - Sort │ │ U - Untag All V - Linked Script ^U - Undo │ ╘════════════════════════════════════════════════════════════════════F1 Help═══╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Enter the text to scan for -or- [ESC] to Abort ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ NOTE: Remember that the text search also scans all Note Files. As a result, if the text is not found, the search could take a few seconds. In addition, it is possible that the matching text is in a Note File, rather than and in the entry's name or number. If that is the case, press 'N' to see the note file. Don't go off the deep end thinking that the text search command is broken; it isn't. If the last entry is reached before a match is found, the following window will be displayed: ╔════════════════════════════════════════════════╗ ╒═════ Status ══════╕ │ Text not found │ ╘═══════════════════╛ ╚════════════════════════════════════════════════╝ Version 4.0 107 A - Find Again ______________________________________________________________________ The Find Again command repeats the last Find Text command from the next entry forward. If no additional matches are found, the following window will be displayed: ╔════════════════════════════════════════════════╗ ╒═════ Status ══════╕ │ No more matches │ ╘═══════════════════╛ ╚════════════════════════════════════════════════╝ L - LOAD ______________________________________________________________________ The 'L' command is used to load an alternate phone book. If the new phone book does not exist, you will be prompted to create it. Pressing 'L' displays the following window: ╔════════════════════════════════════════════════╗ ╞══════════════════════════════════ Commands ══════════════════════════════════╡ │ Entries Dial FON │ │ ╒═════════════════════════ FON File Allocation ═════════════════════════╕ │ │ │ │ │ │ │ > C:\QMODEM\QMODEM.FON░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ │ │ │ │ │ │ ╘══════════════════════════════════════════════════════════ / F1 Help═╛ │ │ T - Tag Multiple N - Attached Note S - Sort │ │ U - Untag All V - Linked Script ^U - Undo │ ╘════════════════════════════════════════════════════════════════════F1 Help═══╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Edit File/Pathname -or- [ESC] to Exit ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ To load a new phone book, type its name (with optional drive and path information) in the prompt window and [ENTER]. The .FON extension is not required; it is assumed by Qmodem. If the file does not exist, a new one will be created automatically using the default parameters defined in the Alt-N/M/C Setup Menu. 108 Qmodem Operations Manual Starting with Qmodem 4.0, all phone book files must have a .FON extension. Should you use pre-4.0 phone books with a different file extension, they must be renamed to the mandatory .FON file type (the filename may have to be changed as well to prevent duplication). This was made necessary when Attached Notes were added to Qmodem. Since the Note Files are assigned the same name as the directory they are attached to, duplicate phone book filenames would present severe conflicts. This restriction can be circumvented if phone books reside in separate sub-directories as long as the main Qmodem phone book file extension is .FON. (ie, QMODEM.FON) Version 4.0 109 O - Other Info ______________________________________________________________________ Pressing 'O' alternates the dialing directory display and allows viewing of the "right Half" of the directory information. Following is a directory display after the 'O' key was pressed. Note the new information shown: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Phone Book ═════════════════════════════════╕ │ Page 1 of C:\QMODEM\QMODEM.FON │ │ Total Tags > 0 Prefixes > ABC │ │[D] Name Password LastCall Total P D │ │1 ≡ Test Node at Forbin testing 08-22-88 854 F F │ │2 Forbin Project Main Number Sysop! 08-18-88 619 F F │ │3 0 F │ │4 0 F │ │5 0 F │ │6 0 F │ │7 GEnie_Local 1200 Baud Qmodem 08-17-88 412 1 H │ │8 0 F │ │9 ≡ Sound of Music V9600 08-22-88 122 G F │ │10 LANS Node 1 HST Qmodem 08-07-88 113 F F │ ╞══════════════════════════════════ Commands ══════════════════════════════════╡ │ Entries Dial FON │ │ SPACE - Tag/Untag ENTER - Starts Dialing F - Find Text │ │ C - Clear Tagged ESC - Cancel/Exit A - Find Again │ │ E - Edit Prefixes M - Manual Dial L - Load │ │ Q - QuickLearn O - Other Info │ │ R - Revise Edit P - Print │ │ T - Tag Multiple N - Attached Note S - Sort │ │ U - Untag All V - Linked Script ^U - Undo │ ╘════════════════════════════════════════════════════════════════════F1 Help═══╛ ▒▒▒▒ Move Bar : PgUp PgDn ^PgUp ^PgDn [ENTER] to Dial [ESC] to Exit ▒▒▒ ╚════════════════════════════════════════════════╝ The additional directory information displayed includes fields labeled LastCall, Total, P, and E. "LastCall" (last CONNECT date) and "Total" (total CONNECTS) are maintained by Qmodem, while the P(rotocol) and E(Cho, or Duplex setting) fields are user-defined. NOTE: Qmodem does not maintain a "Last Dialed" and "Total Dialed" fields; the Last Call and Total fields shown only reflect successful CONNECTIONS to the entry. 110 Qmodem Operations Manual P - Print ______________________________________________________________________ The 'P' (print) command produces a formatted ASCII copy of the Phone Book on a printer or text file. When pressing 'P', Qmodem will prompt you for a valid DOS device device or filename. The default (PRN) routes the output to the printer (usually LPT1:). By changing the default to a valid DOS filename, the output is redirected to the selected file. Pressing 'P' displays the following window: ╔════════════════════════════════════════════════╗ ╞══════════════════════════════════ Commands ══════════════════════════════════╡ │ Entries Dial FON │ │ SPACE - Tag/Untag ENTER - Starts Dialing F - Find Text │ │ C - Clear Tagged ESC - Cancel/Exit A - Find Again │ │ ╒═══════════════════════════ Print Phone Book ════════════════════════════╕ │ │ │ Device or File > PRN░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ │ │ ╘═════════════════════════════════════════════════════════════════════════╛ │ │ T - Tag Multiple N - Attached Note S - Sort │ │ U - Untag All V - Linked Script ^U - Undo │ ╘════════════════════════════════════════════════════════════════════F1 Help═══╛ ▒▒▒▒▒▒▒▒▒▒ Enter the destination device or filename. [ESC] to Abort ▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ Note the PRN default in the window. To override it, backspace and type the new device or filename: ╔══════════════════════════════════════════════════╗ ╒═══════════════════════════ Print Phone Book ════════════════════════════╕ │ Device or File > C:\QMODEM\PHONEPRN.TXT░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ ╘═════════════════════════════════════════════════════════════════════════╛ ╚══════════════════════════════════════════════════╝ The above example will create a phone book listing and store it in the file PHONEPRN.TXT in the C:\QMODEM directory. Other valid devices include LPT1:, LPT2:, LPT3:, COM1:, etc... Version 4.0 111 Following is a sample of the formatted phone book listing: ╔════════════════════════════════════════════════╗ Qmodem Version 4.0 Phone Book ============================= Page 1 of C:\QMODEM\QMODEM.FON Name Number Com Script ------------------------------------------------------------------------------ 1 -------- FORBIN NUMBERS --- -------------------- 19200-8-N-1 SYSOP2 2 Subscription LineTwo HST 233-6157 19200-8-N-1 SYSOP2 3 Subscription LineThree HST 233-6256 19200-8-N-1 SYSOP2 4 Subscription LineFour HST 233-6324 19200-8-N-1 SYSOP2 5 Subscription LineFive V9600 233-6006 19200-8-N-1 SYSOP2 6 ExecNet QMAIL 1-914-667-4759 19200-8-N-1 EXECMAIL 7 The Executive Network HST 1-914-667-4759 19200-8-N-1 EXECNET 8 Cheers! HST 1-901-373-5941 19200-8-N-1 CHEERS 9 GEnie_Local 1200 Baud 277-4741 1200-8-N-1 GENIE.F2 10 Salt Air PCBoard HST 1-801-261-8977 19200-8-N-1 SALT-AIR 11 Hayes Support BBS V9600 19200-8-N-1 HAYES Qmodem Copyright (C) The Forbin Project, Inc. ╚════════════════════════════════════════════════╝ The previous display is a sample printout merged into this document. Your own output will be different, of course. Each page contains a standard header with page numbers, the name of the Phone Book being printed, and the actual phone book entries. The entry numbers shown in the listing are assigned sequentially starting with number 1. Since the Print command does not process blank entries, these number are NOT the same as the entries' number shown in the Phone Book NOTE: Entries and listing numbers will match only if blank entries appear at the end of the phone book -- ie, no empty entries are imbedded between non-blank entries --. 112 Qmodem Operations Manual S - Sort ______________________________________________________________________ The Sort command, as its name indicates, sorts the phone book in one of three user-selected sequences:: 1. By Name field 2. By Phone Number field 3. By Total Connects Pressing 'S' displays the following window: ╔════════════════════════════════════════════════╗ ╞══════════════════════════════════ Commands ══════════════════════════════════╡ │ Entries Dial FON │ │ SPACE - Tag/Untag ╒══════ Sort by ══════╕ing F - Find Text │ │ C - Clear Tagged │ 1 - Name (A) │ A - Find Again │ │ E - Edit Prefixes │ 2 - Number (A) │ L - Load │ │ Q - QuickLearn │ 3 - Total Calls (D) │ O - Other Info │ │ R - Revise ╘══════════════F1 Help╛ P - Print │ │ T - Tag Multiple N - Attached Note S - Sort │ │ U - Untag All V - Linked Script ^U - Undo │ ╘════════════════════════════════════════════════════════════════════F1 Help═══╛ ▒▒▒▒▒▒▒▒▒▒▒ Select the field to Sort by. (A)cending (D)ecending ▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ To select the sort field, press '1', '2', or '3' to Sort, or press [ESC] to cancel the operation. Name and Number sorts are in Ascending ASCII sequence (A), with number being sorted before letters. Sorts by Total Calls are in Descending sequence. As a result, the most- frequently called entries will move toward the top of the Phone Book (higher numbers being placed first). NOTE: As a safety measure, the Phone Book is backed up prior to being sorted. Should you change your mind, the previous unsorted copy of the Phone Book can be restored immediately via the Undo command, covered next. ^U - Undo ______________________________________________________________________ Prior to any changes, a snapshot of the Phone Book is taken, and the Phone Book is saved in a backup file with the same name as the original and a file extension of .FBK. The last Phone Book backup can be restored immediately via the Undo command. Version 4.0 113 When pressing ^U (Ctrl-U), Qmodem looks for a file with the same name as the current phone book and an .FBK extension, If found, that file will be loaded in place of the current Phone Book. If no .FBK file is found, an Information Window will be displayed, stating that no backups were found. Alt-E DUPLEX TOGGLE. ______________________________________________________________________ Alt-E switches Qmodem operation between Full Duplex and Half Duplex modes. "Duplex" describes the method used in echoing your keystrokes back to your terminal screen. In FULL DUPLEX Mode, the REMOTE SYSTEM you are connected to echoes your keystrokes back to your terminal. In Half-Duplex Mode, the remote system does not echo your keystrokes, and Qmodem must do it instead. NOTE: An incorrect Duplex setting will yield one of two results: either you will NOT see any keystrokes displayed on your screen as you type, or your keystrokes will be duplicated (ie, HHEELLOO). In the first case, you are operating in HALF Duplex mode, and you should switch to FULL. In the second case, you are operating in FULL Duplex mode and you should switch to HALF. NOTE: Most Hayes-compatible modems feature an internal Echo setting. If set to ON, the modem itself will echo your keystrokes. If your Qmodem settings are correct, but keystrokes are duplicated, the modem is likely to be the culprit. Check your modem manual for switch settings or initalization parameters to turn the local echo off. When presing Alt-E, the following status window will be displayed: ╔════════════════════════════════════════════════╗ ╒══ Status ═══╕ │ Full Duplex │ ╘═════════════╛ ╚════════════════════════════════════════════════╝ 114 Qmodem Operations Manual Alt-F SCRIPT FILE EXECUTION. What is a Script? ______________________________________________________________________ Scripts are Qmodem Programs. Qmodem features a command language to automate and/or time-schedule logons and interactions with remote computers. Scripts can be used on commercial services such as CompuServe, Delphi, Dow Jones News/Retrieval, GEnie, MCI-Mail, NewsNet, The Source and local BBS systems such as PCBoard, Fido, Nochange, and RBBS-PC. With a script, you need only type a few keystrokes to set communication parameters, dial (and re-dial) the phone, connect to another computer, log on with your name and account number or password, retrieve and save information, and log off. Since everything is automated, there are no mistakes or wasted time spent online. If used properly, scripts can save you money. Executing a script is a two step process. Pressing Alt-F displays the script File Allocation Window, in which you must type the desired script name. Qmodem will then issue a prompt for any additional parameters which should be passed to the script. The following are samples of Script File Allocation and Execution windows: ╔════════════════════════════════════════════════╗ ╒═══════════════════════ Script File Allocation ════════════════════════╕ │ │ │ > C:\QMODEM\SCRIPTS\TEST1.SCR░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ │ │ ╘══════════════════════════════════════════════════════════ / F1 Help═╛ ╒════════════════════════ Script File Execution ════════════════════════╕ │Script to execute : │ │> C:\QMODEM\SCRIPTS\TEST1.SCR │ │Enter Script Parameters (if any) │ │> │ ╘═══════════════════════════════════════════════════════════════F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Edit File/Pathname -or- [ESC] to Exit ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ Once you have entered any additional parameters, if any, the script will begin. Version 4.0 115 NOTE: Scripts must be located in the Scripts Directory specified in the Alt-N/D/S Setup Menu. If the default directory is blank, Qmodem will as look for the scripts in the current directory. For more information on Scripts, refer to the Scripts Section of the Qmodem manual. Alt-G TERMINAL EMULATION. ______________________________________________________________________ The Terminal Emulation feature allows Qmodem to behave like a terminal other than a standard PC display, such as the popular VT100 from Digital Equipment Corpσ. While in terminal emulation mode, Qmodem interprets device-dependent information so that it is displayed properly on the PC screen as if it were a native terminal of the selected type. Qmodem can emulate four (4) types of terminals: TTY - No emulation at all. ANSI - Emulates the ANSI.SYS of PC DOS. VT100 - Emulates the Digital VT100. When pressing Alt-G, the following window will be displayed: ╔════════════════════════════════════════════════╗ ╒══ Terminal Emulation ══╕ │ Current = ANSI │ │ A - TTY │ │ B - ANSI │ │ C - VT100 │ │ Your Choice ? │ ╘════════════════F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Select emulation mode, or [ESC] to Exit ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ To select the desired emulation mode, press the corresponding letter. The screen will be cleared and the Qmodem Status Line will reflect the new emulation mode. NOTE: If you are in Split-Screen mode (via Alt-S), you may not select a new terminal emulation mode. In order to operate properly, Split-Screen mode forces TTY emulation. 116 Qmodem Operations Manual TTY ______________________________________________________________________ This has no specific character translations or function keys. The full ASCII character set is supported with the IBM extended character set (codes 128-255). TTY does not include cursor control codes or enhanced video options. TIP: When calling BBS systems, the ANSI emulation is recommended. ANSI ______________________________________________________________________ This emulation is recommended for BBS usage. Complete IBM ANSI.SYS compatibility is built right in. You do not need to load the ANSI.SYS driver in your CONFIG.SYS file. KEY ANSI FUNCTION XMITED CODE ______________________________________________________________________ Tab Horizontal Tab 0x09 Del Character delete 0x7F Home Home the Cursor 0x1B5B48 Up Arrow Cursor Up 0x1B5B41 Down Arrow Cursor Down 0x1B5B42 Left Arrow Cursor Left 0x1B5B44 Right Arrow Cursor Right 0x1B5B43 PgDn Clear Screen 0x1B5B324A End Erase End of Line 0x1B5B4B Enter Carriage Return 0x0D Ctrl-Enter Linefeed 0x0A VT100 ______________________________________________________________________ Qmodem supports the standard VT100 functions; half/full duplex, set/reset modes, scrolling region, keypad application mode, special graphics character set, US & UK character sets, full display attributes including ANSI color extensions, programmable tabs and cursor control. To take advantage of larger screen dimensions other than 80x25, you must have an EGA or VGA card that supports more lines and columns in text mode. Assuming you have such a card, place the card in the desired mode (say, 132x43) and then select the VT100 emulation. Until changed manually (via Alt-2, Alt-4 or an external driver), the screen will lock in on the selected dimensions. Version 4.0 117 Qmodem responds to the "Identify" command (0x1B5B63 or 0x1B5A) with "ESC[?1;2c" (0x1B5B3F313B3263). KEY VT100 FUNCTION XMITED CODE ______________________________________________________________________ Tab Horizontal Tab 0x09 Del Character delete 0x7F Home Home the Cursor 0x1B5B48 Up Arrow Cursor Up 0x1B5B41 Down Arrow Cursor Down 0x1B5B42 Left Arrow Cursor Left 0x1B5B44 Right Arrow Cursor Right 0x1B5B43 PgDn Clear Screen 0x1B5B481B5B324A End Erase End of Line 0x1B5B4B Enter Carriage Return 0x0D Ctrl-Enter Linefeed 0x0A Alt-H HANG UP. ______________________________________________________________________ The Hangup command is used to force the modem to terminate a call. In most cases, you would NOT use this command to disconnect from the remote computer; you would use the remote computer's standard LOG OFF procedure. However, in case you are experiencing problems (ie, remote computer lockup, bad line noise, etc...) you may use this command to disconnect the call. What Alt-H does varies, depending on the information specified in the Alt-N/M/M/H Setup Menu. Usually, Qmodem will send the modem hangup string defined in your setup. However, if you specified "DTR" as a modem hangup string, Qmodem will toggle the "DTR" signal and the connection will be dropped. And if you specified "BREAK", the UART BREAK signal will be sent. The recommended Hangup string for Hayesσ and compatible modems is: "^~^~^~+++^~^~^~ATH^M" where: ^~^~^~ = 1.5 seconds delay +++ = go to Command Mode string ^~^~^~ = another 1.5 seconds delay ATH = command to Hangup ^M = the [ENTER] key 118 Qmodem Operations Manual "DTR" stands for "Data Terminal Ready". Most modems will automatically disconnect from the phone line DTR signal is dropped for 1.5 seconds. Having the three characters "DTR" in the Hangup string does exactly that. If in doubt, check your modem manual to see if "Dropping DTR" is an accepted method of dicconnecting. If so, this should be the preferred method. BREAK is a signal generated by the UART (Universal Asynchronous Receiver / Transmitter, the main chip on your serial adapter or modem). Some PBX and Bell type modems require a BREAK signal before they will take action. Again, check your modem manual before setting this option. When pressing Alt-H, the following Status window will be displayed: ╔════════════════════════════════════════════════╗ ╒════════ Status ═════════╕ │ Sending Hang-Up command │ ╘═════════════════════════╛ ╚════════════════════════════════════════════════╝ Alt-I INFORMATION ON QMODEM. ______________________________________________________________________ The Qmodem information screen always displays the Qmodem release number, as well as an official Invoice Form which can be printed (Via PrtSc), filled out, and sent in to register your copy of the program. The Forbin Project depends on your honesty to register the program if you use it. This allows us to keep on improving the software and supply you with top quality technical support when you need it. Version 4.0 119 Alt-J FUNCTION KEY MACROS. ______________________________________________________________________ Function key (FKey for short) macros are used to store keystrokes which are sent repetitively. When pressing Alt-J, the following window is displayed:: ╔════════════════════════════════════════════════╗ ╒═════════════════════════ Function Key Assignment ══════════════════════════╕ │ Normal Shift Ctrl Alt │ │F1 @Edit F1 @Script messag F1 @Shell ESU 43 F1 │ │F2 @Script QuikDi F2 @QLEARN F2 F2 @Script HST20 │ │F3 ..^M\/ F3 @script c F3 F3 @Dial TSalt │ │F4 ^M F4 @Script GEnie. F4 F4 │ │F5 AT M0H1^M F5 F5 @Script UP. F5 │ │F6 AT M1H0^M F6 F5 @Script DOWN. F6 │ │F7 John^M F7 @Script Colors F7 F7 Be right back. │ │F8 Friel^M F8 @Script Test1 F8 F8 I'm Back! │ │F9 $Password^M F9 F9 F9 @DIAL TGEnie_L │ │F10 @Script REG F10 F10 F10 @script who │ │F11 @Script ShowLo F11 F11 F11 Welcome!^M │ │F12 @Shell Map F12 F12 F12 @Script RTSETU │ │ │ │ Key File is Z:\QMODEM.KEY │ │ │ │ 1 - Normal 2 - Shift 3 - Ctrl 4 - Alt L - Load ESC - Exit │ │ │ │ Your Choice ? _ │ ╘════════════════════════════════════════════════════════════════════F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ [1-4] to Display/Edit -or- [ESC] to Exit ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ Up to 48 FKey Macros may be programmed at one time. FKey Macros are stored in "Key Definition Files" with .KEY file extensions and user- assigned filenames. Each can store up to 4 separate macros, depending on the key's Shift state (Fn, Shift-Fn, Ctrl-Fn and Alt-Fn). To execute an FKey Macro, press the desired Shift key, hold it down, and strike the Fn key. Pressing Alt-J displays the FKey Macro Screen shown above. The first 14 characters of each FKeys are displayed in 4 columns corresponding to the shift states described earlier. The status line at the bottom of the window displays summary instructions on how to display and/or edit each series of macros, load an alternate key definition file, or exit the Alt-J screen. 120 Qmodem Operations Manual To view the complete key definitions for a given shift state, press the number (1-4) corresponding to that state (1=Normal, 2=Shift, 3=Ctrl, 4=Alt). Editing Key Macros ______________________________________________________________________ To edit an FKey macro, press the number (1-4) corresponding to the key's shift state, as described above. The following edit screen will then be displayed (in the following example, the '3' key was pressed to display/edit Alt-Fn key assignments): ╔════════════════════════════════════════════════╗ ╒═════════════════════════ Function Key Assignment ══════════════════════════╕ │ Definitions for Alt F-keys │ │F1 @SHELL MAP │ │F2 @SCRIPT SETCOLOR 7 1 "String passed to S2" │ │F3 @DIAL TSalt░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ │F4 @EDIT │ │F5 @STAMP this will be put in the LOG file. │ │F6 @SHELLX DEL *.BAK │ │F7 Be right back... went to the kitchen.... │ │F8 I'm Back! │ │F9 @Dial TGEnie_Local │ │F10 @Script WHO │ │F11 $PASSWORD^M │ │F12 @Script RTSETUP │ │ │ │ Valid Edit Keys : INS - Insert mode Toggle - Field Up │ │ DEL - Delete Character - Field Down │ │ - Character Left ^ - Word Left │ │ - Character Right ^ - Word Right │ │ Special Characters : ^M = [ENTER] ^~ = ½ second delay │ ╘════════════════════════════════════════════════════════════════════F1 Help═╛ ▒▒▒▒▒ Edit Function Key Entries [F10] to Save [ESC] to Abort changes ▒▒▒▒▒ ╚════════════════════════════════════════════════╝ The Alt-J edit screen features a scrollbar cursor. In the example, the cursor is located on the F3 key. Move the scrollbar with the up/down arrow keys to select the key definition to edit. The following section describes available macro keywords and commands in detail. Version 4.0 121 DOS Shell Macros ______________________________________________________________________ Two macro commands, @SHELL and @SHELLX allow you to quickly access DOS with the touch of a key. Any program, with the exception of those that attach themselves to DOS (TSR's) can be executed provided enough free memory is available. Examples: ╔══════════════════════════════════════════════════╗ @SHELL CHKDSK C:░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ╚══════════════════════════════════════════════════╝ This will run the DOS Chkdsk program on drive C:. When complete, it will stop and prompt you to press a key before returning to Qmodem (and erasing the screen). ╔══════════════════════════════════════════════════╗ @SHELLX DEL *.BAK░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ╚══════════════════════════════════════════════════╝ This will delete all the files with the extension of ".BAK" and immediatly return when completed. ╔══════════════════════════════════════════════════╗ @SHELL ESU 43░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ╚══════════════════════════════════════════════════╝ If you have a Vega VGA, this is the program used to switch video modes on the fly. The @SHELL macros will detect video mode changes and reset Qmodem when returning from DOS. A handy way to use those SuperEGA and SuperVGA cards to get higher screen resolutions and larger viewing areas. A Dial Macro ______________________________________________________________________ The @DIAL macro is just like invoking an Alt-D/T command. Any text following the @DIAL is parsed in the same way that Alt-D/T does. For more information, refer to the Alt-D/T section. 122 Qmodem Operations Manual Examples: ╔══════════════════════════════════════════════════╗ @DIAL TSALT-AIR░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ╚══════════════════════════════════════════════════╝ This will search all entries for the text "SAlt-Air". The search is not case sensitive. The Name, Number and attached Notes are searched. All entries that match are tagged and then dialing will start. ╔══════════════════════════════════════════════════╗ @DIAL 1 2 23 155░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ╚══════════════════════════════════════════════════╝ This will tag entries 1, 2, 23 and 155 to be dialed. ╔══════════════════════════════════════════════════╗ @DIAL 1 TO 200░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ╚══════════════════════════════════════════════════╝ This will tag entry 1, then all the entries with the letter 'O', and finally entry 200. NOTE: @DIAL will do an implied "Untag-All" before applying the new tags. An Edit Macro ______________________________________________________________________ The @EDIT macro allows you to quickly call up the internal editor to edit/view a file. If a filename follows @EDIT, that file will be brought up in edit immediately. If no filename has been specified, then you will be prompted for one. Examples: ╔══════════════════════════════════════════════════╗ @EDIT░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ╚══════════════════════════════════════════════════╝ Version 4.0 123 This will prompt for the filename to edit. ╔══════════════════════════════════════════════════╗ @EDIT QMHOST.PWD░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ╚══════════════════════════════════════════════════╝ This will edit the Internal HOST database file. A Script Macro ______________________________________________________________________ In the example above, entries Alt-F2, Alt-F10 and Alt-F12 use the keyword @SCRIPT. The @SCRIPT macro command causes execution of the Script whose filename follows (the .SCR script file extension is not required). If the script requires parameters, they must be included in the key definition following the script name. The @SCRIPT macro, the script name, and script parameters must be separated by at least one space. Examples: ╔══════════════════════════════════════════════════╗ @SCRIPT TEST1░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ╚══════════════════════════════════════════════════╝ This will call the script "TEST1.SCR". Because ".SCR" was not included in the filename, it is added by default. ╔══════════════════════════════════════════════════╗ @SCRIPT TEST1.░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ╚══════════════════════════════════════════════════╝ This will call the script "TEST1". Because the period is at the end of the script name, the default extension is not included. ╔══════════════════════════════════════════════════╗ @SCRIPT SETCOLOR 7 1 "String passed to S2"░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ╚══════════════════════════════════════════════════╝ 124 Qmodem Operations Manual This will call the Script SETCOLOR and pass it 3 parameters. Parameter 1 is the character "7", parameter 2 is "1" and parameter 3 is "String passed to S2". Since the third parameter is text with imbedded spaces, it must be enclosed within double quotes. A LOG Macro ______________________________________________________________________ The @STAMP macro causes the text following it to be recorded into the current LOG file, preceded by the current time and date. For more information on the Qmodem LOG file, refer to the Alt-0 Command. Example: ╔══════════════════════════════════════════════════╗ @STAMP This will be put in the LOG file.░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ╚══════════════════════════════════════════════════╝ The LOG file entry would look like this (except with the current time and date) : ╔════════════════════════════════════════════════╗ 16:26:54 11-20-88 This will be put in the LOG file. ╚════════════════════════════════════════════════╝ NOTE: The special characters "^~" and "^M" have no meaning when @STAMP is used. The $PASSWORD Variable ______________________________________________________________________ When used in a key macro definition, $PASSWORD variable is replaced by the current entry's PASSWORD field (see Alt-D). Whenever a connection is made, the dialed entry's Password is automatically loaded into the $PASSWORD variable. Unlike all the other special macro commands which must appear first in the macro, $PASSWORD may be used anywhere within the macro text. Version 4.0 125 Example: Let's assume that the word "QMODEM!" is the password for the entry we have just connected to and the following was coded for Alt-F11: ╔══════════════════════════════════════════════════╗ My password is $PASSWORD░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ╚══════════════════════════════════════════════════╝ After the connection is made, pressing Alt-F11 would send the following: My password is QMODEM! Simple, no? Loading a new Key file ______________________________________________________________________ Pressing the 'L' key while in the main Alt-J screen will load a new .KEY file, if found. If the specified .KEY file does not exist, Qmodem will issue a prompt for its creation -- that's how new key definition files are made --. 126 Qmodem Operations Manual Alt-K CHANGING THE ACTIVE COM PORT. ______________________________________________________________________ The Alt-K commands is used to switch the active serial communications port. After pressing Alt-K, the following window is displayed: ╔════════════════════════════════════════════════╗ ╒══════════════ Set Active COM Port ═══════════════╕ │ Active COM Port is COM1 │ │ Available ports are : │ │ │ │ 1 - COM1: 2 - COM2: │ │ 3 - COM3: 4 - COM4: │ │ 5 - COM5: 6 - COM6: │ │ 7 - Undefined 8 - Undefined │ │ │ │ Your Choice ? │ │ │ ╘══════════════════════════════════════════F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Select a different COM Port [ESC] to Exit ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ Qmodem supports up to 8 serial communication ports (COM1 through COM8). Only the ports specifically defined in your setup will be identified in the Alt-K menu; others will be shown as "Undefined". In the above example, ports 1 through 6 were defined during Qmodem installation. To select a new communication port, press the desired number (1-8). Once the new port is selected, Qmodem will close the current port and open the new one. Communication parameters (Baud rate, parity, start/stop bits) will remain unchanged. To change the new port's communication parameters, use the Alt-P command. Version 4.0 127 Alt-L CHANGING THE LOGGED DRIVE. ______________________________________________________________________ "Logged Drive" refers to the default drive at the time Qmodem was started. This drive specification may be changed by using the Alt-L command. Pressing Alt-L displays the following prompt window: ╔════════════════════════════════════════════════╗ ╒══ Change Log Drive ══╕ │ Logged Drive is : D │ │ Enter new Drive : │ ╘══════════════F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Enter a new Drive letter [A-Z] -or- [ESC] to Exit ▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ To select a new default drive, type its drive letter and [ENTER]. Qmodem will verify the new drive specification before proceeding. If the drive is invalid, a message to that effect will be displayed and a new drive prompt will be issued. Pressing ESC will cancel the drive change request. 128 Qmodem Operations Manual Alt-M MUSIC TOGGLE. ______________________________________________________________________ Music will be generated on the PC's speaker only if the following conditions are met: 1. ANSI terminal emulation is active (see Alt-G). 2. The Music Toggle is ON (see Alt-M). 3. Qmodem receives encoded music data. If any of the above condition is not met, Qmodem will disregard encoded music information. To be recognized by Qmodem, encoded music data must conform to the following format: ESC [ M .....music codes..... ^N Where ESC stands for the ASCII escape character (ASCII 27) or ^[. Music codes are those used in the BASIC language PLAY statement (please refer to your BASIC language manual for further information on the PLAY statement). Music strings must end with the ctrl-N or ^N character. If the ^N character is missing, Qmodem will assume that the following text, up to 255 characters, is playable music. It might not sound too good, however. Alt-N INVOKING THE SETUP MENU. ______________________________________________________________________ Qinstall, which used to be a separate SETUP program in earlier releases of Qmodem, has been incorporated into Qmodem release 4.0. All previous Qmodem setup parameters, and many new ones, are now easily accessible via the Alt-N command. Through a series of pull- down pop-up menus, Qmodem setup is now faster and much easier than the old stand-alone Qinstall program. Almost all of Qmodem's operational parameters can be customized. You may change the colors, upload or download directory paths or even add an external protocol without leaving Qmodem. To use the Alt-N command requires that enough free memory be present. If this is not the case, you must exit Qmodem via the Alt-X; command and run the Qinstall program externally. Refer to the SETUP section at the beginning of the manual for complete installation instructions. Version 4.0 129 Alt-O CHANGING SUBDIRECTORIES. ______________________________________________________________________ By definition, a directory listing request (see Alt-W) will display the current subdirectory. However, the default subdirectory is that which was active when Qmodem was started. In order to view the contents of other directories, the current directory must be changed via the Alt-O command. When pressing Alt-O, the following windows are displayed: ╔════════════════════════════════════════════════╗ ╒═════════ SubDirs ══════════╕ │ . .. │ │ HOSTDIR DL │ │ MASTER MODEMS │ │ MPI SCRIPTS │ │ SITEVERS XFERS │ │ QMAIL ANALYST │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ╒════════════════════════ Change Subdirectory ════════════════════════╕ │ │ │ │ │ > C:\QMODEM\░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ │ │ │ │ ╘══════════════════════════════════════════════════════════ / F1 Help═╛ │ │ ╘════════════════════════════╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Edit File/Pathname -or- [ESC] to Exit ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ The larger, vertical window on the left side of the screen shows a list of all valid subdirectories in the directory you are in. If there are no lower directory levels, that list will be empty. The horizontal window on top shows the current drive:\path and contains a prompt area in which the new path specification is typed. To change paths, type the new drive:\directory specification as you would in a valid CHDIR command. 130 Qmodem Operations Manual If you wish to change to a subdirectory listed in the left window, you only need type that name at the end of the prompt. For example, to select the PCBOARD subdirectory, you would type "PCBOARD" and press [ENTER]. If the drive:\path is invalid, the following error message appears in the Change Subdirectory window and waits for a key to be pressed: Invalid Path specified. Press any key Pressing any key returns the prompt the way it was when Alt-O was originally pressed giving you another chance to enter the correct path. To exit Alt-O without changing the drive:\path, just press [ESC]. TIP: The Alt-O command allows you to change drives as well as subdirectories. If the new path command includes a drive specification (IE, D:\DATA), and the drive letter is valid, the current Logged Drive will be changed as well. Alt-P COMMUNICATIONS PARAMETERS. ______________________________________________________________________ The Alt-P command allows immediate changes to serial communications parameters. Pressing Alt-P displays the following window: ╔════════════════════════════════════════════════╗ ╒════════════════════ Set Modem Speed ═════════════════════╕ │ Current setting is COM1: 19200,N,8,1 │ │ │ │ Speed Parity Data Stop │ │ A - 300 E - 9600 H - Even K - 7 M - 1 │ │ B - 1200 F - 19200 I - Odd L - 8 N - 2 │ │ C - 2400 G - 38400 J - None │ │ D - 4800 │ │ │ │ Your Choice ? _ │ ╘══════════════════════════════════════════════════F1 Help═╛ ▒▒▒▒▒▒▒ [Letter] to Select -or- [ENTER] to Accept -or- [ESC] to Abort ▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ Select the new parameter(s) by pressing the corresponding option letter. If an error was made, pressing [ESC] restores the previous parameters and exits the Alt-P window. Pressing [ENTER] completes the parameter change(s) and exits the window. Version 4.0 131 For example, say we want to set Qmodem to 1200,7,E,1 and the current setting is 19200,N,8,1. We would press the following letters; B,H and press [ENTER]. You might be wondering... Why didn't we need to press K to set 7 data bits? Because when either H or I is selected, it forces K. Alt-Q QUICKLEARN SCRIPT RECORDER. ______________________________________________________________________ The QuickLearn Script Recorder is much like a video camera; as it records your interactions, it creates a Script which can be replayed later to replicate the session while QuickLearn was active. Alt-Q is a toggle; if the QuickLearn recorder is not active, it is started. If it is active, it terminates and the Script is saved. In a nutshell, QuickLearn stores incoming data internally until you type information yourself. QuickLearn assumes that your data was entered in response to a prompt or question from the system you are connected to. The last 32 characters received are assumed to be the prompt to which you are responding, which will be reflected in the final script as a WAITFOR command. In turn, the entire contents of your response will be included in the script as a SEND command. The "Q" tag was mentioned in the Dialing Directory section (Alt-D Command). If an entry is tagged by pressing "Q", the dialer will start QuickLearn automatically -- but only if a Script file name is defined and the file itself does not exist --. As a result, script recording starts the instant the connection is established. What if you are already online and want to create a script to perform a repetitive function? You would invoke Alt-Q! When pressing Alt-Q, Qmodem displays the following script file allocation window: ╔════════════════════════════════════════════════╗ ╒═══════════════════════ Script Learn Allocation ═══════════════════════╕ │ │ │ > C:\QMODEM\SCRIPTS\░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ │ │ ╘══════════════════════════════════════════════════════════ / F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Edit File/Pathname -or- [ESC] to Exit ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ 132 Qmodem Operations Manual Type the desired script file name and [Enter]. If the script already exists, an overwrite prompt will be displayed. You may chose to overwrite the prompt, or select a new name for the script. If the script file is not found, it will be created. While QuickLearn is active, the status line is changed to the following: ╔════════════════════════════════════════════════╗ ▒▒▒▒▒▒▒▒▒▒▒▒ QuickLearn Recording Active! [Alt-Q] to end recording ▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ When you are finished recording a script, press Alt-Q again. Qmodem will display the following status window, after which the standard Status Line will be restored. ╔════════════════════════════════════════════════╗ ╒═════════ Status ══════════╕ │ QuickLearn recording done │ ╘═══════════════════════════╛ ╚════════════════════════════════════════════════╝ Version 4.0 133 Saving the Current Setup ______________________________________________________________________ QuickLearn saves the state of Qmodem environment variables at the beginning of each Script. These variables include toggles such as Split-screen mode (SPLIT), Duplex setting (ECHO), etc.. as shown below: ╔════════════════════════════════════════════════╗ ; ; QuickLearn Script generated at 11:45:06 on 12-08-88 ; May require editing before use. ; TurnON 8_BIT TurnOFF LINEFEED TurnON XON/XOFF TurnON NOISE TurnON MUSIC TurnON SCROLL TurnOFF PRINT TurnOFF ECHO TurnOFF SPLIT TurnOFF BS_DEL ; TimeOut 30 ; Set Waitfor timeout to 30 seconds ╚════════════════════════════════════════════════╝ This sample was created by pressing Alt-Q, entering a script filename, and then pressing Alt-Q again to save the file. The top of each Quicklearned script contains a time and date stamp, followed by the 10 Qmodem commands needed to restore the environment at the time the script was recorded. Note the second line: the script may require editing before use. QuickLearn also forces a default script TIMEOUT command of 30 seconds (the last line of the sample script). This default value is hard- coded in Qmodem and can only be changed by manually editing the script. The default value is probably higher than necessary. Set this value to the longest estimated time the script will have to wait on data from the other system; if the delay exceeds the TIMEOUT value, the script will be cancelled automatically. 134 Qmodem Operations Manual As QuickLearn records the session, it may capture text strings which contain variable data, such as time and/or date information. A good example would be a script created while logging on to a Bulletin Board System (BBS). Many Bbs's feature command line prompts which include time used and time remaining for the current session. The values recorded in the original script may never be matched by the values received when the script is replayed. For example: ╔════════════════════════════════════════════════╗ WaitFor "56 min. left) Qmodem Conference Command?" Delay 100 Send "R S NS^M" ╚════════════════════════════════════════════════╝ Needless to say, the script will ONLY work if there are EXACTLY 56 minutes left. Likely, the WAITFOR command will wait forever for a prompt that will never come. To eliminate this problem, edit the WAITFOR command and remove variable information which is likely to cause problems: ╔════════════════════════════════════════════════╗ WaitFor "Conference Command?" Delay 100 Send "R S NS^M" ╚════════════════════════════════════════════════╝ The "56 min. left) Qmodem " was removed from the WAITFOR string, leaving a generic prompt which will work at any time, and in any conference. Commands that are recorded ______________________________________________________________________ QuickLearn also records certain Qmodem commands. Following is a list of supported Qmodem commands, and examples of the generated script commands which replicate them: Alt-B Beeps & Bells toggle TurnON NOISE TurnOFF NOISE Version 4.0 135 Alt-C Clears the screen ClrScr Alt-D Dial an entry number Dial "1" Note: Only one entry can be tagged. Alt-D/L Load a new FON book LoadFON C:\QMODEM\QMODEM.FON Alt-E Half/Full Duplex toggle TurnON ECHO TurnOFF ECHO Alt-G Change current terminal emulation mode Graphics TTY Graphics ANSI Graphics VT100 Alt-H Terminate the connection HangUp Alt-J/L Load a new KEY file LoadKEY C:\QMODEM\VT100.KEY Alt-K Change current COM Port selection Port 1 Alt-L Change current Logged Drive Drive C 136 Qmodem Operations Manual Alt-M Toggle playing of MUSIC if detected TurnON MUSIC TurnOFF MUSIC Alt-O Change current Subdirectory ChDir C:\QMODEM\SCRIPTS Alt-P Change current Baud Rate SetComm 19200 8 NONE 1 Alt-Q Toggle the QuickLearn mode [none, for reference only] Alt-R Execute the DOS shell DOS "COMMAND" Alt-S Toggle the Split Screen mode TurnON SPLIT TurnOFF SPLIT Alt-U Toggle the Scroll-back capture TurnON SCROLL TurnOFF SCROLL Alt-V View a File with an external program DOS "LIST filename" Note: cannot use either @FSE or @EDITOR Alt-X Exit the Script AND Qmodem SYSTEM Y/X Version 4.0 137 Alt-Y Delete a File DOS "DEL filename" Alt-Z Toggle the Xon/Xoff flow control TurnON XON/XOFF TurnOFF XON/XOFF Alt-1 Toggle the Backspace/DEL key output TurnON BS_DEL TurnOFF BS_DEL Alt-2 Set 80x25 line mode for EGA/VGA EGA 25 Alt-4 Set 80x43/50 line mode for EGA/VGA EGA 43 Alt-8 Toggle the Hi-Bit display TurnON 8_BIT TurnOFF 8_BIT Alt-9 Toggle the Printer Echo TurnON PRINT TurnOFF PRINT Alt-0 Toggle the LOG file on/off TurnOFF LOG LOG C:\QMODEM\QMODEM.LOG Sh-Tab Toggle the Add Linefeeds TurnON LINEFEED TurnOFF LINEFEED 138 Qmodem Operations Manual ^Home Toggle the Capture file on/off TurnOFF CAPTURE CAPTURE C:\QMODEM\CAPTURE.TXT ^End Send the UART BREAK signal Break PgUp/ Upload (send) a file ^PgUp Upload X filename PgDn/ Download (receive) a file ^PgDn Download X filename FKey xx Function Key macro execution FKey 13 [shift F1 key] Putting it all together ______________________________________________________________________ Now that the basics have been covered, let's go over a sample QuickLearn recording session. The scripts were recorded while calling the Forbin Project PCBoard BBS, Home of Qmodem. First, a little advance information: we will call using the Alt-D directory with an attached script name of "FORBIN". The Password field in Alt-D for the Forbin entry will be used to link to an FKey macro (F9 in this example). In the Function Key setup (Alt-J), we must edit the F9 key to contain the string "$PASSWORD^M". Once this is done, we can press Alt-D and tag the Forbin entry with a "Q" to invoke QuickLearn. Version 4.0 139 In this example, the Fkey assignments are blank. Our F9 entry should look like: ╔════════════════════════════════════════════════╗ ╒═════════════════════════ Function Key Assignment ══════════════════════════╕ │ Normal Shift Ctrl Alt │ │F1 F1 F1 F1 │ │F2 F2 F2 F2 │ │F3 F3 F3 F3 │ │F4 F4 F4 F4 │ │F5 F5 F5 F5 │ │F6 F6 F5 F6 │ │F7 F7 F7 F7 │ │F8 F8 F8 F8 │ │F9 $PASSWORD^M F9 F9 F9 │ │F10 F10 F10 F10 │ │F11 F11 F11 F11 │ │F12 F12 F12 F12 │ │ │ │ Key File is C:\QMODEM\QMODEM.KEY │ │ │ │ 1 - Normal 2 - Shift 3 - Ctrl 4 - Alt L - Load ESC - Exit │ │ │ │ Your Choice ? _ │ ╘════════════════════════════════════════════════════════════════════F1 Help═╛ ╚════════════════════════════════════════════════╝ 140 Qmodem Operations Manual The Alt-D screen is also blank except for the first directory entry for the Forbin Project BBS. The second screen snapshot shows the "O"ther page of the directory with the Password field "MyPassword!". ╔════════════════════════════════════════════════╗ ╒═════════════════════════════════ Phone Book ═════════════════════════════════╕ │ Page 1 of C:\QMODEM\QMODEM.FON │ │ Total Tags > 1 Prefixes > ABC │ │[D] Name Number COM Script │ │1 Q Forbin Project BBS 1-319-233-6157 19200-8-N-1 FORBIN.SCR │ │2 19200-8-N-1 │ ╒═════════════════════════════════ Phone Book ═════════════════════════════════╕ │ Page 1 of C:\QMODEM\QMODEM.FON │ │ Total Tags > 1 Prefixes > ABC │ │[D] Name Password LastCall Total P D │ │1 Q Forbin Project BBS MyPassword! 08-22-88 1 F F │ │2 F F │ ╚════════════════════════════════════════════════╝ Version 4.0 141 Calling Forbin... ╔════════════════════════════════════════════════╗ CONNECT 19200 / 12-08-88 (13:39) (Error Correcting Modem Detected) The Forbin Project PCBoard System PCBoard (R) - Version 14.0/E9 (Beta) - Node 2 Do you want ANSI Graphics (Enter)=no? n <----- (1) The Forbin Project PCBoard Home of ██████████ ███ ███ ██████████ ██████████ ████████████ ███ ███ ███▒▒▒▒▒▒███ █████ █████▒███▒▒▒▒▒▒███ ███▒▒▒▒▒███ ███▒▒▒▒▒▒▒▒▒▒█████ █████▒ ███▒ ███▒████████████▒███▒ ███▒███▒ ███ ███▒ ████████████▒ ███▒ ███▒███▒▒██▒▒███▒███▒ ███▒███▒ ███▒████████ ███▒▒██▒▒███▒ ███▒ ███▒███▒ ▒▒ ███▒███▒ ███▒███▒ ███▒███▒▒▒▒▒▒ ███▒ ▒▒ ███▒ ███▒ ██ ███▒███▒ ███▒███▒ ███▒███▒ ███▒███▒ ███▒ ███▒ ███▒ █████▒███▒ ███▒███▒ ███▒███▒ ███▒▒███▒ ███▒ ███▒ ██████████▒▒███▒ ███▒███████████▒▒██████████▒▒ ████████████ ███▒ ███▒ ▒▒▒▒▒▒▒███ ▒▒▒ ▒▒▒ ▒▒▒▒▒▒▒▒▒▒ ▒▒▒▒▒▒▒▒▒▒ ▒▒▒▒▒▒▒▒▒▒▒▒ ▒▒▒ ▒▒▒ ▒▒▒ What is your first name? john <----- (2) What is your last name? friel <----- (3) Password (Dots will echo)? ........... <----- (4) Scan Message Base Since 'Last Read' (Enter)=yes? <----- (5) (Ctrl-K) or (Ctrl-X) Aborts, (Ctrl-S) Suspends. Scanning Main (0) . Msgs For You: 2907 Msgs From You: None # Msgs Found: 1 (0----+----10---+----20---+----30---+----) (M123456789012345678901234567890123456789) MBase Areas: XXXXXXXXXXXXXXXXXXXXXXXXXXXX MBase Scans: XXXXXXXXXXXXXXXXXXXXXXXXXXXX Caller Num.: 121355 Active Msgs: 795 Tr/Protocol: None (Choose one above) (998 min. left) Main Board Command? <----- (6) ╚════════════════════════════════════════════════╝ 142 Qmodem Operations Manual Wherever information was entered in response to a prompt, it is followed by a "<--- (n)" tag. Following is a review of the above session: 1. N[ENTER] ANSI graphics was not wanted. 2. John[ENTER] Entered my first name. 3. Friel[ENTER] Entered my last name. 4. F9 Pressed the F9 key to send my password. 5. [ENTER] Pressed ENTER to scan Message base. 6. Alt-Q Pressed Alt-Q to end QuickLearn! Version 4.0 143 And QuickLearn generated the following script: ╔════════════════════════════════════════════════╗ ; ; QuickLearn Script generated at 13:52:38 on 12-08-88 ; May require editing before use. ; TurnON 8_BIT TurnOFF LINEFEED TurnON XON/XOFF TurnON NOISE TurnON MUSIC TurnON SCROLL TurnOFF PRINT TurnOFF ECHO TurnOFF SPLIT TurnOFF BS_DEL ; TimeOut 30 ; Set Waitfor timeout to 30 seconds Waitfor "want ANSI Graphics (Enter)=no?" Delay 100 Send "n^M" <----- (1) Waitfor "What is your first name?" Delay 100 Send "john^M" <----- (2) Waitfor "What is your last name?" Delay 100 Send "friel^M" <----- (3) Waitfor "Password (Dots will echo)?" Delay 100 FKey 9 <----- (4) Waitfor "Since 'Last Read' (Enter)=yes?" Delay 100 Send "^M" <----- (5) Waitfor "Press (Enter) to continue?" Delay 100 Send "^M" Waitfor "min. left) Main Board Command?" Delay 100 Exit ; End of Script <----- (6) ╚════════════════════════════════════════════════╝ 144 Qmodem Operations Manual NOTE: The "<--- (n)" tags were added for reference purposes only. Alt-R DOS SHELL. ______________________________________________________________________ If enough system memory is available and a copy of COMMAND.COM can be located via the COMSPEC= environment variable or in the DOS PATH, you may "Shell" to DOS. Pressing Alt-R yields the following screen: ╔════════════════════════════════════════════════╗ Qmodem «--» DOS Shell The IBM Personal Computer DOS Version 3.10 (C)Copyright International Business Machines Corp 1981, 1985 (C)Copyright Microsoft Corp 1981, 1985 « Qmodem SST DOS Shell. Type EXIT to return » C:\>_ ╚════════════════════════════════════════════════╝ During a DOS Shell, Qmodem is still running, capturing incoming data. All standard DOS commands are available from within the DOS Shell. For example, you could copy files, format a disk, or run a separate program AS LONG AS THERE IS SUFFICIENT MEMORY AVAILABLE TO DO SO. To return to Qmodem, type "EXIT" and press [ENTER] at the DOS prompt. The Qmodem screen will be restored to its previous status. NOTE: The Alt-R command modifies your existing PROMPT command to include the message shown above. This is only a temporary change so you do not forget Qmodem is running. CAUTION: If the DOS shell remains active too long, Qmodem buffers may overflow and cause loss of data. Version 4.0 145 Possible Error conditions ______________________________________________________________________ While in the DOS Shell, you may not execute programs which attach themselves to DOS, terminate, and stay resident (IE. SideKick). If such a program is loaded, the following message will be displayed when you attempt to EXIT back to Qmodem: ╔══════════════════════════════════════════════════╗ A TSR was loaded while executing the DOS Shell and Qmodem cannot recover. A Reboot (Ctrl-Alt-Del) is recommended at this time. > Tap any key to continue < ╚══════════════════════════════════════════════════╝ At this point, you can return to Qmodem, but only long enough to save any open files and re-boot the system. Your online session will not be disturbed and you can get right back online by executing Qmodem again. .FON File Protection ______________________________________________________________________ When returning from a DOS shell, Qmodem checks the Phone Directory (.FON file) to see if it has been updated. If it has, then it is automatically reloaded. This feature was implemented to allow execution of external phone book editors such as QFE from Sunflower Systems. Alternate Screen Sizes ______________________________________________________________________ The Qmodem DOS Shell is able to recognize a screen size change (feasible with EGA and VGA displays), and will adjust accordingly. If an external program changes the size of the screen while in the DOS Shell, that change will be recognized upon return to Qmodem. Under normal circumstances, Qmodem restores the screen to its size before the DOS Shell was invoked. If a size change is detected, the following Status window will be displayed: ╔════════════════════════════════════════════════╗ ╒═════════════════ Status ══════════════════╕ │ Video mode changed. Screen not restored. │ ╘═══════════════════════════════════════════╛ ╚════════════════════════════════════════════════╝ 146 Qmodem Operations Manual Alt-S SPLIT SCREEN MODE. ______________________________________________________________________ In split-screen mode, Qmodem divides the screen into two areas to separate incoming and outgoing text: ╔════════════════════════════════════════════════╗ ══[ Keystrokes Queued 0 ]═══════[ Split Screen ]════════════════════════════════ ▒ TTY Offline 19200-8-N-1 ▒ Home=? ▒ FDX ▒ 8 X LG ▒ 10:33:18 ▒ ╚════════════════════════════════════════════════╝ The larger section at the top of the screen is reserved for incoming text received from the remote computer. The smaller section at the bottom of the screen echoes transmitted keystrokes. Current keystrokes are displayed on the screen's dividing line. Qmodem implements a true split-screen mode, complete with a 254 character input buffer. Pressing [ENTER] immediately transmits the buffer and clears it for additional input. Stored keystrokes are displayed on the screen's dividing line. The characters "^M" can be used to substitute an [ENTER] in the string. If another terminal emulation other than TTY is in effect when Alt-S is pressed, it is remembered so it can be restored when split screen is exited. The split screen mode requires TTY emulation to operate correctly. NOTE: If you use FKey macros, ^M will not cause the contents of the character buffer to be sent; the text stored in the FKey macro will be appended to the buffer. Version 4.0 147 Alt-T SCREEN DUMP. ______________________________________________________________________ Screen contents can be copied to a disk file via the Alt-T command. When pressing Alt-T, the following window is displayed: ╔════════════════════════════════════════════════╗ ╒═════════════════════ Screen Dump File Allocation ═════════════════════╕ │ │ │ > C:\SCREEN.DMP░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ │ │ ╘══════════════════════════════════════════════════════════ / F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Edit File/Pathname -or- [ESC] to Exit ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ The default file name is that defined in the Qmodem configuration; it may be changed in the Alt-T prompt. The screen contents are APPENDed (added to the end of) to the screen dump file and are preceded by with a Time and Date stamp. If the screen dump file does not exist, a file creation prompt will be issued. If the dump was successful, Qmodem will issue a quick "bleep" sound, accompanied by a confirmation message in the Alt-T window: ╔════════════════════════════════════════════════╗ ╒══════════════ Status ═══════════════╕ │ Screen Dump saved to C:\SCREEN.DMP │ ╘═════════════════════════════════════╛ ╚════════════════════════════════════════════════╝ Alt-U SCROLL BACK TOGGLE. ______________________________________________________________________ The Alt-U Scroll-back command toggle use of Qmodem's scroll-back capture buffer. The Scroll-back command is discussed under the heading "Up Arrow" later in the documentation. Qmodem starts with Scroll-back capture ACTIVE: all data displayed on the screen is stored in the scroll-back buffer for later recall. 148 Qmodem Operations Manual When pressing Alt-U, the following Status window is displayed: ╔════════════════════════════════════════════════╗ ╒════ Status ═════╕ │ Scroll Back OFF │ ╘═════════════════╛ ╒════ Status ═════╕ │ Scroll Back ON │ ╘═════════════════╛ ╚════════════════════════════════════════════════╝ Alt-V VIEW A FILE. ______________________________________________________________________ Pressing Alt-V invokes the file viewer/editor program. When that command is issued, the View/Edit file allocation window is displayed: ╔════════════════════════════════════════════════╗ ╒════════════════════════ View File Allocation ═════════════════════════╕ │ │ │ > L ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ │ │ ╘══════════════════════════════════════════════════════════ / F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Edit File/Pathname -or- [ESC] to Exit ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ Alt-V can be thought of as a flexible gateway used to browse or edit a file. The above example assumes use of Vern Buerg's popular LIST (TM) program, available on most Bbs's. LIST is sophisticated replacement for the DOS TYPE command. Although intended for file browsing or editing, the Alt-V gateway can be used to invoke any program, even WordStarσ! The program to be called by Alt-V can be defined in Setup (Alt-N/F/V) or can be changed on the fly. For example, you could type "DEL *.BAK" and [ENTER] to delete all the files in the current directory with an extension of ".BAK". NOTE: If an external program is specified, a DOS Shell is used and sufficient memory must be available. Version 4.0 149 Alt-V also accepts two special commands: @FSE and @EDITOR. If you specify either of these at the beginning of the command, the following actions will take place: @FSE instructs Qmodem to use its internal editor to edit/view the file. This also assumes that the text following @FSE is a valid DOS filename. The size of the file is limited by the memory assigned to the editor in the Alt-N/O/M/E Setup menu. Following is an example of Alt-V use to edit the AUTOEXEC.BAT file in the C:\ directory: ╔════════════════════════════════════════════════╗ ╒════════════════════════ View File Allocation ═════════════════════════╕ │ │ │ > @FSE C:\AUTOEXEC.BAT░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ │ │ ╘══════════════════════════════════════════════════════════ / F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Edit File/Pathname -or- [ESC] to Exit ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ @EDITOR instructs Qmodem to use the user-defined editor rather than the Qmodem internal editor in any function where the internal editor would have been used --such as editing the attached Note files in the dialing directory (Alt-D/N) or the attached Scripts (Alt-D/V)--. The following example uses the @EDITOR keyword to define Microsoft Word as the editor: ╔════════════════════════════════════════════════╗ ╒════════════════════════ View File Allocation ═════════════════════════╕ │ │ │ > @EDITOR WORD C:\AUTOEXEC.BAT░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ │ │ ╘══════════════════════════════════════════════════════════ / F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Edit File/Pathname -or- [ESC] to Exit ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ 150 Qmodem Operations Manual Alt-W DISK DIRECTORY. ______________________________________________________________________ The Alt-W command is Qmodem's internal version of the "DIR /p". DOS command. Qmodem will produce a file listing of the current directory (see the Alt-W command to change directory). In addition, an estimated file transfer time will be shown for each file, based on the current baud rate. To experiment, change the baud rate with the Alt-P command and see the effect the change has on the estimated transfer times shown in Alt-W. NOTE: If you are using a floppy based system, you will first be prompted to insert a diskette into the drive. Following is a sample Alt-W display: ╔════════════════════════════════════════════════╗ ╒═ Filename Bytes Time Date XmitTime ══╕ │ │ │Disk has no Volume Label. │ │ Path : Z:\ │ │ Use Pattern *.* │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ╘══════════════════════════════════════════F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Key in a Filename, * ? are valid. [CR] = *.* ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ As is the case with the DOS prompt, you may change the directory listing argument, with all standard wildcard "*?" characters being supported. Pressing [ENTER] defaults to *.* (all files). Refer to your DOS manual for proper use of wildcard characters in DIR commands. Alt-W displays one screen of information at a time and prompts for a keystroke before going on. Pressing [ESC] skips the remainder of the listing and displays free space on the current drive. The next keystroke following [ESC] or the normal end of the directory listing will return Qmodem to the standard terminal screen. Version 4.0 151 Following is a sample of a directory listing: ╔════════════════════════════════════════════════╗ ╒═ Filename Bytes Time Date XmitTime ══╕ │Disk has no Volume Label. │ │ Path : Z:\ │ │ . <DIR> 13:16 07-29-88 00:00:01 │ │ .. <DIR> 13:16 07-29-88 00:00:01 │ │ HOSTDIR <DIR> 13:16 07-29-88 00:00:01 │ │ DL <DIR> 13:20 07-29-88 00:00:01 │ │ MASTER <DIR> 13:20 07-29-88 00:00:01 │ │ MODEMS <DIR> 13:22 07-29-88 00:00:01 │ │ MPI <DIR> 13:22 07-29-88 00:00:01 │ │ SCRIPTS <DIR> 13:22 07-29-88 00:00:01 │ │ SITEVERS <DIR> 13:27 07-29-88 00:00:01 │ │ XFERS <DIR> 13:27 07-29-88 00:00:01 │ │ !DIRTREE.1DR 352 8:19 07-26-88 00:00:01 │ │ ARK24K.CNF 3072 18:03 03-21-88 00:00:03 │ │ AS.PAS 1312 10:08 05-04-88 00:00:01 │ │ AS2.PAS 97 10:09 05-04-88 00:00:01 │ │ ASYNC.TPU 960 21:37 08-15-88 00:00:01 │ │ BACKIT.BAT 29 1:14 05-11-88 00:00:01 │ │ BAUD.PAS 8362 15:35 08-05-88 00:00:06 │ │ BAUD.TPU 4848 16:34 08-20-88 00:00:04 │ │ BINED.TPU 24352 18:30 03-23-88 00:00:17 │ │ Tap any key to continue, [ESC] to exit │ ╘══════════════════════════════════════════F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ Alt-X EXITING QMODEM. ______________________________________________________________________ To exit Qmodem, press Alt-X. The following prompt window will be displayed: ╔════════════════════════════════════════════════╗ ╒════════ Exit Qmodem ════════╕ │ Are you sure? [Y/N/X] _ │ ╘═════════════════════F1 Help═╛ ▒▒▒▒ [Y]es - Drop DTR and Exit [N]o - Return [X] - Leave DTR Up and Exit ▒▒▒ ╚════════════════════════════════════════════════╝ 152 Qmodem Operations Manual Replying Y to the prompt will immediately terminate Qmodem, close the serial port (and hang up the modem if a connection was active), and close the Capture and LOG files if they were opened. Entering an "X" will cause Qmodem to exit to DOS and leave the DTR line active, which does NOT hang up the modem and retains the connection if one was active. This allows you to perform any other process, such as run an external program which requires more memory then is available via the Qmodem DOS Shell facility. When the "X" option is used AND you are online, the environment settings are saved in a file called QMODEM.INI. The next time Qmodem is started, the values stored in QMODEM.INI will override the default configuration, and QMODEM.INI is deleted. If Qmodem is NOT restarted, the QMODEM.INI file will remain and should be deleted if not needed. Replying N to the prompt or pressing [ESC] cancels the exit request and returns Qmodem to the terminal screen. CAUTION: Data received after you exit Qmodem via Alt-X-X will be lost. Use this exit option when you are sure no data will be sent by the remote computer (IE, the remote computer is waiting for YOUR input). Most modems and many remote computers will disconnect if the connection remains inactive for an extended period of time. Be aware of these limitations when exiting Qmodem via Alt-X-X. Alt-Y DELETE A FILE. ______________________________________________________________________ Alt-Y is a powerful command used to permanently delete a file. When pressing Alt-Y, the File Delete Allocation Window will be displayed: ╔════════════════════════════════════════════════╗ ╒═══════════════════════ File Delete Allocation ════════════════════════╕ │ │ │ > Z:░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ │ │ ╘══════════════════════════════════════════════════════════ / F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Edit File/Pathname -or- [ESC] to Exit ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ Version 4.0 153 Type the desired file name in the space provided and [ENTER]. Qmodem will verify that the file exists. If it does, a second confirmation prompt will be issued, just to be sure: ╔════════════════════════════════════════════════╗ ╒═════════════════ File Delete - Be Careful! ═════════════════╕ │ You are about to delete the following file │ │ Z:HEADERS │ │ │ │ Are you SURE ??? [Y/N] _ │ │ │ ╘═════════════════════════════════════════════════════F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ [Y] to delete the file [N] to abort ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ This is your last chance. If you erase the wrong file, issue the Alt-R DOS Shell command IMMEDIATELY and attempt to recover the lost file with a program such as Norton's Undelete, PCTools, Mace Utilities etc... There is no UNERASE facility built into Qmodem. Alt-Z XON/XOFF TOGGLE. ______________________________________________________________________ Alt-Z toggles Xon/Xoff flow control. XON/XOFF is a simple means of controlling data flow, used mostly by mini and mainframe computers. With Xon/Xoff in the OFF mode, a buffer overrun may occur on long ASCII text transmissions (incoming data will exceed Qmodem's internal buffer capacity). If Xon/Xoff is ON and Qmodem detects the Xoff (^S) code, the following window will be displayed: ╔════════════════════════════════════════════════╗ ╒═══ Status ════╕ │ Xon/Xoff OFF │ ╘═══════════════╛ ╚════════════════════════════════════════════════╝ 154 Qmodem Operations Manual When the remote system is ready to receive more data, it will send the Xon (^Q) code and the window will disappear. If you believe there is a problem, you can manually restart the data transfer by pressing ^Q. FILE TRANSFERS-Protocol Selection ______________________________________________________________________ Selecting a protocol is the first step in a file upload or download. Pressing PgUp (upload or send) or PgDn (download or receive) will display the same protocol window (except for the upload/download window label): ╔════════════════════════════════════════════════╗ ╒═══ Upload Protocols ═══╕ │ A - Ascii │ │ X - Xmodem │ │ C - Xmodem CRC │ │ R - Xmodem Relaxed │ │ O - Xmodem-1K │ │ Y - Ymodem (batch) │ │ F - Xmodem-1K/G │ │ G - Ymodem/G (batch) │ │ Your Choice ? │ ╘════════════════F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒ Select a Protocol for the File Transfer. [ESC] to Exit ▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ Version 4.0 155 If external protocols are available, they will be displayed at the bottom of the protocol selection window: ╔════════════════════════════════════════════════╗ ╒═══ Upload Protocols ═══╕ │ A - Ascii │ │ X - Xmodem │ │ C - Xmodem CRC │ │ R - Xmodem Relaxed │ │ O - Xmodem-1K │ │ Y - Ymodem (batch) │ │ F - Xmodem-1K/G │ │ G - Ymodem/G (batch) │ ╞═══════ External ═══════╡ │ Z - Zmodem │ │ Q - QMail Zmodem │ │ Your Choice ? │ ╘════════════════F1 Help═╛ ╚════════════════════════════════════════════════╝ The protocol selection windows both feature the "F" and "G" protocols (Xmodem-1K/G and Ymodem/G). These are "Hardware-handshaking" protocols which can only be used if your computer is equipped with an error-correcting modem (IE. a modem which supports MNP). To activate these, CTS checking must be specified in the Alt-N/O/T setup menu. If CTS checking is not specified, or if it is specified and your computer is not equipped with an error-correcting modem, the F and G selections will not be available. NOTE: Protocol letter assignments have been changed in Qmodem 4.0. These are now compatible with the standard protocol selection letters in PCBoard(TM), release 14. NOTE: The Imodem protocol is no longer supported in Qmodem 4.0. The new F and G protocols are now fully compatible with the Xmodem1K/G and Ymodem/G (batch) standards defined by Omen Technology, and implemented in their DSZ external communication driver. When uploading or downloading files, both sending and receiving computers must use the same communication protocol. Select the agreed- upon protocol by pressing the corresponding letter. "X", for example, would select Xmodem, which is supported almost universally. 156 Qmodem Operations Manual NOTE: Bulletin Board (BBS) programs each use a different method for selecting file transfer protocols. When communicating with a BBS, make sure that you have selected the proper protocol on the BBS System before making the protocol selection in Qmodem. Once the protocol has been selected, the selection window will disappear and two new windows will be displayed on the screen:. ╔════════════════════════════════════════════════╗ ╒═══════════════════════ Upload File Allocation ════════════════════════╕ │ │ │ > ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ │ │ ╘══════════════════════════════════════════════════════════ / F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Edit File/Pathname -or- [ESC] to Exit ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ Whether uploading (sending) or downloading (receiving), Qmodem displays a prompt for the name and extension of the file to be sent to or received from the other computer. Qmodem has the ability to "pick" file names directly from the screen. Qmodem scans the screen from right to left and bottom to top for a valid file name. "Valid File Name" is defined as a 1- to 8-character text string followed by a period and a 2- or 3-character suffix. Spaces, semicolons, and the left and right margins are valid file name delimiters. Following are some examples of valid and invalid file names: THISFILE.TXT valid README.1 invalid (not enough chars in suffix) QMDMSST.ARC valid PROGRAM.THIS invalid (too many characters in suffix) MPROGRAM1.THIS invalid (name too long) If Qmodem did not find a suitable file name, or if the one picked is not correct, the file name must be added or edited manually. Once the desired file name has been specified, press [Enter] to start the file transfer. Version 4.0 157 ASCII Protocol ______________________________________________________________________ The ASCII protocol is used primarily for online text transfers; it does not support the transfer of binary data (such as programs, compressed files etc...). NOTE: Unlike most other protocols, ASCII does not perform any error-checking, which makes it very sensitive to line noise. Bursts of phone line interference will introduce stray characters which are not part of the data being transmitted. For this reason, ASCII transfers are not recommended unless they are used for specific purposes where that protocol is needed (IE., uploading message data directly into a BBS message base). When ASCII mode is selected, XON/XOFF flow control is in effect. Pressing [ESC] at any time will terminate the transfer. During an ASCII transfer, the screen is divided into two areas (similar to the Alt-S split-screen mode). Following is a sample ASCII upload (sending the Z:\QMODEM.LOG file): ╔════════════════════════════════════════════════╗ 16:50:20 11-18-88 Online Timer Started. 16:50:29 11-18-88 ********** HOST STARTED ********** 16:50:58 11-18-88 @HOST CALLER > JOHN FRIEL 16:51:05 11-18-88 @HOST HANGUP > JOHN off 16:51:06 11-18-88 Hangup Command entered. 16:51:08 11-18-88 Elapsed Online 00:00:47 16:51:32 11-18-88 *********** HOST ENDED *********** 17:44:39 11-18-88 Connected With : Exec-QwikNet Mail-Stop 17:44:39 11-18-88 ++ Phone Number : 1-914-667-4759 17:44:39 11-18-88 ++ Comm Speed : 19200-8-N-1 ════════════ Outgoing Text ═════════════ Incoming Text ════════════ 16:50:20 11-18-88 Online Timer Started. 16:50:29 11-18-88 ********** HOST STARTED ********** 16:50:58 11-18-88 @HOST CALLER > JOHN FRIEL 16:51:05 11-18-88 @HOST HANGUP > JOHN off 16:51:06 11-18-88 Hangup Command entered. 16:51:08 11-18-88 Elapsed Online 00:00:47 16:51:32 11-18-88 *********** HOST ENDED *********** 17:44:39 11-18-88 Connected With : Exec-QwikNet Mail-Stop 17:44:39 11-18-88 ++ Phone Number : 1-914-667-4759 17:44:39 11-18-88 ++ Comm Speed : 19200-8-N-1 ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Uploading Z:\QMODEM.LOG [ESC] to Terminate ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ 158 Qmodem Operations Manual Outgoing text is displayed in the lower window. Text received by the other computer, if echoed back, will be displayed in the top window. NOTE: ASCII transfer parameters are defined in the Alt-N/P/A Setup menu. XMODEM Protocol ______________________________________________________________________ There are two XMODEM protocols currently in use. The original Xmodem uses a "Checksum" method to insure that the data received is the same as that which was sent. Checksum is a very simple error-detection method with an accuracy rate of 99.6%. Xmodem-Checksum transmits 128- byte data blocks. XMODEM CRC ______________________________________________________________________ Xmodem-CRC (Cyclic Redundancy Checking) is similar to Xmodem-Checksum, but uses a far more reliable error-detection algorithm (99.9969%.). In the event that the wrong Xmodem protocol was selected, Qmodem will correct itself automatically, eliminating the need for aborting the transfer. RELAXED XMODEM ______________________________________________________________________ Relaxed Xmodem is basically identical to Xmodem-Checksum, but error timing has been relaxed by a factor of 10. In other words, it takes ten times longer for an error condition to be generated. This protocol was designed specifically for CompuServe communications, due to the questionable implementation of Xmodem by that Online Information Service. XMODEM-1K ______________________________________________________________________ Xmodem-1K is a modified version of Xmodem CRC, which uses 1024-byte blocks as opposed to Xmodem's 128 byte blocks. In earlier releases of Qmodem, this protocol was referred to as Ymodem. The name has been changed to reflect the addition of True Ymodem ((c) Omen Technology) to Qmodem 4.0. YMODEM (batch) ______________________________________________________________________ Ymodem is the true implementation of the YMODEM batch protocol and is referred to as YMODEM or YMODEM BATCH. This protocol supports the transfer of multiple files within a single session which does not require user intervention. Version 4.0 159 When using Ymodem, only one filename can be specified at a time. To allow multiple file transfers, wildcards must be used in the filename for uploads. For downloads, Qmodem will automatically retrieve the names of the files being sent from their respective header records. Example: ╔════════════════════════════════════════════════╗ ╒═══════════════════════ Upload File Allocation ════════════════════════╕ │ │ │ > FILENAME.1 FILENAME.2 FILENAME.3░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ │ │ ╘══════════════════════════════════════════════════════════ / F1 Help═╛ ╚════════════════════════════════════════════════╝ This is INCORRECT. You cannot enter multiple filenames. Instead, use the following: ╔════════════════════════════════════════════════╗ ╒═══════════════════════ Upload File Allocation ════════════════════════╕ │ │ │ > FILENAME.?░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ │ │ ╘══════════════════════════════════════════════════════════ / F1 Help═╛ ╚════════════════════════════════════════════════╝ XMODEM-1K/G & YMODEM/G ______________________________________________________________________ These two protocols are identical to their non-/G counterparts. /G protocols do not perform any error detection and rely on the error- correction features of the modems. Modems equipped with internal protocols such as MNP, LAP-B, and X.PC insure that communications are error-free. Hardware handshaking via the CTS/RTS signal lines must be enabled with such modems. /G protocols will not be available unless the following is true: CTS checking is enabled in the Alt-N/O/T/C Setup menu option. The modem's CTS signal is enabled when the serial port is initialized. 160 Qmodem Operations Manual CAUTION: Make sure that the modem does not force the CTS signal ON at all times. This will cause a modem buffer overflow resulting in an aborted transfer. NOTE: Xmodem-1K/G and Ymodem/G cannot retransmit bad data blocks. In theory, there should be NO bad blocks of data in an error-free connection. If errors occur, they are likely to be cause by an improper setup in either the modem or Qmodem. High-speed or Error-Correcting modems communicate with Qmodem at the hardware level via the CTS/RTS interface. The modem cables used in conventional modems (IE 1200/2400, non-MNP units) may not carry all the necessary signals (pins could be missing). The wrong cable could prevent Qmodem from detecting the CTS signal, and ignore the modem's hardware-handshaking capabilities. When in doubt, use a serial cable with all 25 pins connected (a flat ribbon, 25-conductor cable). AT Users may use a 9-pin to 25-pin adapter with all 9 lines connected, attached to a 25-conductor cable as described above. External Protocols ______________________________________________________________________ Due to their nature, External protocols do not have a seamless interface and operate differently from built-in protocols. When an external protocol is used, Qmodem invokes the protocol's upload or download BATCH file which in turn executes the external protocol's file transfer program. Since Qmodem has no control over external programs, screen displays will be handled entirely by the external program. The screen will be cleared before control is passed to the external protocol, and once the transfer is complete, you will be returned to the standard Qmodem terminal display. For more information on installing External protocols, refer to the Setup (Alt-N/P) section. For protocol-specific information, refer to the external protocol's documentation. PgUp UPLOAD - FILE TRANSFER WINDOW ______________________________________________________________________ Once the protocol has been selected, Qmodem tracks file transfer status information in a special "File Transfer Window", which is covered in this section. Version 4.0 161 NOTE: The Qmodem File Transfer Window is NOT used by external protocols. External protocols use proprietary screen displays which are described in the protocol's own documentation. NOTE: The Transfer Windows used for uploads and downloads are almost identical; it is described here. Only the minor differences between the two windows will be covered in the Download Section of this manual. ╔════════════════════════════════════════════════╗ ╒═══ Upload File (transmit) ════╕ │ Filename : QMODEM.PAS │ │ Protocol : Xmodem-1K │ │ Total Blocks : 10 │ │ Blocks Sent : 7 │ │ Bytes Sent : 7168 │ │ Elapsed Time : 00:00:10 │ │ Average CPS : 717 │ │ Efficiency : 74.7% │ │ Error : 0 │ │ Status Msgs : │ │ 0 % complete 100 │ │ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓■■■■■ │ ╘═══════════════════════════════╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Upload in progress. Press [ESC] to Abort ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ The File Transfer Window has been completely redesigned in release 4.0 of Qmodem. More information is displayed, and its format is simpler and easier to read. The File Transfer Window contains the following fields: Filename: The name of the file being uploaded. Only the filename is displayed; the drive and path are not shown. Protocol: The name of the file transfer protocol. 162 Qmodem Operations Manual Total Blocks: The total number of data blocks in the file. Blocks Sent/Received: The number of blocks transmitted. Bytes Sent/Received: The total Bytes sent so far. Xmodem, Xmodem/CRC and Xmodem Relaxed use a 128-byte block. All other protocols use a 1024 byte (1K) block. Elapsed Time: The amount of time elapsed since the file transfer started. The startup delay during which the two computers synchronize themselves is not counted. Average CPS: Average transfer speed in Character Per Second. This value is re-computed after each block. With non error-correcting modems, the maximum CPS rate is approximately 1/10th the CONNECT rate (IE, 240 CPS when the modems are connected at 2400bps). With high-speed 9600bps modems, Average CPS value can range from 950 to 1200 depending on serial speed, computer speed, protocol used, and phone line quality. Efficiency %: The CPS-to-Connect Rate ratio. This ratio reflects the performance of the file transfer. With non error-correcting modems, the maximum efficiency is 90 to 95%. With high-speed, error-correcting modems (IE., MNP3/MNP4) efficiency can reach 120% to 130% if the serial rate exceeds the connect rate (IE., 19200bps vs. 9600bps). With data compression (MNP5), efficiency on text transfers can reach 170% to 180%. Version 4.0 163 Error: Current error count. If an error occurs, and the block in error is successfully re-transmitted, this counter is reset to 0. If the error count reaches 10, the transfer is aborted. Status Msgs: File transfer status messages, such as "SUCCESS", "Waiting for NAK", etc.. Transfer Completion Graph: The bottom of the window displays a moving bar which tracks the progress of the file transfer. This graph is always displayed during uploads. The graph is also displayed during true Ymodem and Ymodem-G downloads, which communicate the file size in their header record, which allows transfer progress to be tracked. PgDn DOWNLOAD PROTOCOLS. ______________________________________________________________________ Since uploads and downloads are essentially identical, only operational differences will be described in this section of the manual. The same protocols are available for both Uploads and Downloads; protocol descriptions will not be repeated. For information on file transfer protocols, please refer to the upload section in this manual. 164 Qmodem Operations Manual The Download Protocol selection window is shown below: ╔════════════════════════════════════════════════╗ ╒══ Download Protocols ══╕ │ Free Space 10145792 │ │ A - Ascii │ │ X - Xmodem │ │ C - Xmodem CRC │ │ R - Xmodem Relaxed │ │ 1 - Xmodem-1K │ │ Y - Ymodem (batch) │ │ F - Xmodem-1K/G │ │ G - Ymodem/G (batch) │ ╞═══════ External ═══════╡ │ Z - Zmodem │ │ Q - QMail Zmodem │ │ Your Choice ? F │ ╘════════════════F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒ Select a Protocol for the File Transfer. [ESC] to Exit ▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ For downloads, Qmodem displays the amount of free space on the download drive at the top of the window. Protocol selections are the same as in the Upload Protocol window. ASCII ______________________________________________________________________ During ASCII downloads, the screen is cleared and a window is displayed stating that pressing [ESC] will terminate the transfer and save the file. If the transfer is started, but no data is received, Qmodem will delete the empty file and return to the terminal screen. Version 4.0 165 XMODEM, XMODEM CRC, XMODEM RELAXED and XMODEM-1K/G ______________________________________________________________________ Following is a sample Download Window for all above protocols: ╔════════════════════════════════════════════════╗ ╒═══ Download File (receive) ═══╕ │ Filename : TESTFILE │ │ Protocol : Xmodem-1K │ │ Blocks : 5 │ │ Bytes : 5120 │ │ Elapsed Time : 00:00:08 │ │ Average CPS : 618 │ │ Efficiency : 64.3% │ │ Error : 0 │ │ Status Msgs : │ │ 0 % complete 100 │ │ status·not·available │ ╘═══════════════════════════════╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Download in progress. Press [ESC] to Abort ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ Note that the download window is very similar to the upload window. The major differences are: Blocks: The number of blocks received. Bytes: The number of bytes received. Bottom Bar: Shows "status not available" because the file size is unknown at the start of the transfer. 166 Qmodem Operations Manual YMODEM and YMODEM/G. ______________________________________________________________________ True Ymodem and Ymodem/G batch protocols include "Header Records" in the downloaded data. These records contain file-dependent information such as name, size, and date/time stamps. As a result, file names need not be specified prior to starting batch downloads. As an added benefit, the moving Transfer Completion Graph is updated during batch downloads since file sizes are known. When the filename is extracted from the header block, it is checked to see if it will create a valid DOS filename. The Ymodem header was designed to be flexible and allow for non MS-DOS file naming conventions. Apple, Atari and Commodore computers are more liberal in their file naming conventions and these need to be converted when downloading these files. Suppose you are calling a non-IBM BBS system and want to download one of their foreign files and you are using Ymodem as the protocol. Qmodem converts their filename to one that is acceptable to MS-DOS on- the-fly. The rules for the conversion are: 1. The last ".", if any, in the Header filename is where the new DOS filename extension will begin. 2. The first 8 character (or less, depending on the position of the "." in step 1) is converted. Periods (".") are replaced with dollar-signs ("$"), and spaces (" ") are replaced with underscores ("_"). Examples: Foreign Filename Converted Filename STARTER.ARC.STV1.2 STARTER$.2 ST.DATAKIT.ARC.4 ST$DATAK.4 ST.SOUND.ARC.1.2 ST$SOUND.2 A LONG NAME.EXTENS A_LONG_N.EXT UP-ARROW SCROLL-BACK. ______________________________________________________________________ As the online session progresses, Qmodem stores all displayed information in a special scroll-back buffer. Pressing the Up-Arrow selects Scroll-back mode. While in this mode, you can scroll backward and forward through previously displayed text. Version 4.0 167 The size of the scroll-back buffer is defined in the Alt-N/O/M/S Setup menu. Following is a sample scroll-back display: ╔════════════════════════════════════════════════╗ Qmodem SST Version 4.0 Compiled Dec 9,1988 Copyright (C) 1984,88 -- The Forbin Project, Inc. Registered to : [UNREGISTERED COPY] Scroll-Back lines available : 250 LOGing to QMODEM.LOG You are now in TERMINAL mode ATZ OK at&v ACTIVE PROFILE: B1 E1 L1 M1 N1 Q0 T V1 W2 X4 Y0 &C1 &D2 &G0 &J0 &K3 &L0 &P0 &Q5 &R0 &S0 &T4 &X0 &Y0 S00:000 S01:000 S02:043 S03:013 S04:010 S05:008 S06:002 S07:060 S08:002 S09:006 S10:014 S11:060 S12:050 S18:000 S25:005 S26:001 S36:003 S37:000 S38:020 STORED PROFILE 0: B1 E1 L1 M1 N1 Q0 T V1 W0 X4 Y0 &C1 &D2 &G0 &J0 &K3 &L0 &P0 &Q5 &R0 &S0 &T4 &X0 S00:000 S06:002 S07:060 S08:002 S09:006 S10:014 S11:060 S12:050 S18:000 S25:005 S26:001 S36:003 S37:000 S38:020 STORED PROFILE 1: B1 E1 L1 M1 N1 Q0 T V1 W0 X4 Y0 &C1 &D2 &G0 &J0 &K3 &L0 &P0 &Q5 &R0 &S0 &T4 &X0 S00:000 S06:002 S07:060 S08:002 S09:006 S10:014 S11:060 S12:050 S18:000 S25:005 ▒▒▒ SCROLL-BACK PgDn [F1]Help [S]ave [C]lear [ESC]Exit Queued 0 ▒▒ ╚════════════════════════════════════════════════╝ In Qmodem 4.0, the Scroll-back status line has been reduced to a single line to increase the text view area. While in scroll-back mode, the following cursor keys are active: Up/Dn: move up or down one line. PgUp/PgDn: move up or down one page at a time. Home/End: move to the top and bottom of the buffer. Pressing [ESC] exits scroll-back mode and returns to the terminal screen. 168 Qmodem Operations Manual Pressing [S] will display a prompt for the name of the file to which the scroll-back buffer is to be saved: ╔════════════════════════════════════════════════╗ ╒══════════════════ Scroll Back Dump File Allocation ═══════════════════╕ │ │ │ > C:\BACKSCRL.SAV░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ │ │ ╘══════════════════════════════════════════════════════════ / F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Edit File/Pathname -or- [ESC] to Exit ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ As with other Qmodem file prompts, you may override the default file name and press [ENTER] to save the file. Pressing [C] clears the Scroll-back buffer and frees up the memory allocated to it. NOTE: The scroll-back buffer uses standard DOS memory. As more data is stored into the scroll-back buffer, the memory available for a DOS Shell or external program is reduced accordingly. If you experience memory shortage while in a DOS Shell, or while running an external program (IE, external editor, external protocol), clearing the scroll- back buffer may alleviate the problem. The "Queued" counter, at the right of the scroll-back status line, tracks the amount of incoming data while you are viewing Scroll-back information. NOTE: ANSI or VT100 graphics which rely on cursor-positioning command are not displayed properly while in scroll-back mode. This is not a bug, but rather an opportunity for a future upgrade. CTRL-HOME CAPTURE TO DISK. ______________________________________________________________________ Ctrl-Home is a toggle which starts or stops Qmodem's Session Capture facility. While Session Capture is active, the data displayed on the screen is also saved to a disk file. Version 4.0 169 When Session Capture is started, the following "Capture" file allocation window will be displayed: ╔════════════════════════════════════════════════╗ ╒═══════════════════════ Capture File Allocation ═══════════════════════╕ │ │ │ > Z:\CAPTURE.1░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │ │ │ ╘══════════════════════════════════════════════════════════ / F1 Help═╛ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ Edit File/Pathname -or- [ESC] to Exit ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ The file name may be changed by backspacing over the default name and typing a new one. If the capture file is new, you will be prompted for its creation. Reply "Y" to do so, or "N" to enter a different name. Pressing [ESC] will cancel the session capture request and return to the terminal screen. Whenever session capture starts, the following status window is displayed: ╔════════════════════════════════════════════════╗ ╒══════════════ Status ═══════════════╕ │ Capture Session to Z:\CAPTURE.1 ON │ ╘═════════════════════════════════════╛ ╚════════════════════════════════════════════════╝ To end Session Capture, press Ctrl-Home again. The capture file will be closed and the following status window will be displayed: ╔════════════════════════════════════════════════╗ ╒══════ Status ═══════╕ │ Capture File Closed │ ╘═════════════════════╛ ╚════════════════════════════════════════════════╝ 170 Qmodem Operations Manual CTRL-END SENDING A TRUE BREAK. ______________________________________________________________________ Pressing Ctrl-End generates a BREAK signal. "BREAK" is a special signal generated by the serial adapter, used to notify the receiving computer of a specific condition. In most cases, BREAK is used to tell the other computer to interrupt whatever it is doing. For example, the GEnie Online Service interprets the BREAK signal in the same manner as your PC would interpret ^C or Ctrl-Break. In response to Ctrl-End, Qmodem displays the following message: ╔════════════════════════════════════════════════╗ <<BREAK>> ╚════════════════════════════════════════════════╝ NOTE: As is the case with PC programs which disable or ignore Ctrl-Break, the BREAK signal may not be recognized by the receiving computer. BREAK handling is a function of the communication software, and this feature may not be implemented in the computer you are communicating with. SHIFT-TAB ADD LINEFEEDS. ______________________________________________________________________ In some cases, text lines may be overwritten on the screen. The most likely reason is that the other computer is not sending Linefeed (LF) characters at the end of each line. Pressing Shift-Tab toggles the addition of a Linefeed (LF) character to each incoming Carriage Return (CR). To turn the Add Linefeed feature OFF, press Shift-Tab again. NOTE: If text lines are double-spaced, Linefeeds are being added when they shouldn't. Press Shift-Tab again to disable Linefeed addition. Version 4.0 171 When Shift-Tab is pressed, one of the following status windows will be displayed: ╔════════════════════════════════════════════════╗ ╒══ Status ══╕ │ Add LF ON │ ╘════════════╛ ╒══ Status ═══╕ │ Add LF OFF │ ╘═════════════╛ ╚════════════════════════════════════════════════╝ Alt-1 BACKSPACE <-> DEL TOGGLE. ______________________________________________________________________ Alt-1 toggles the value generated by the Backspace key between the standard backspace and the DEL character. In normal operating mode, Backspace (BS) and Ctrl-H (^H) are treated in the same fashion and both generate a Backspace (ASCII 8) character. Certain terminals, such as the DEC VT100 require that a DEL character be sent (ASCII 127) when the backspace key is pressed. When pressing Alt-1, one of the following windows will be displayed: ╔════════════════════════════════════════════════╗ ╒════ Status ═════╕ │ Backspace is ^H │ ╘═════════════════╛ ╒═════ Status ══════╕ │ Backspace is DEL │ ╘═══════════════════╛ ╚════════════════════════════════════════════════╝ The BS/DEL setting can be reversed on-the-fly by pressing Ctrl- Backspace. The current status of the BS/DEL toggle is displayed in the Alt-N/O/T setup menu. 172 Qmodem Operations Manual NOTE: If the BS/DEL setting is incorrect, pressing the Backspace key will not yield the desired result on the receiving computer. If the toggle is active and the other computer expects a BS character, it will display the ASCII 127 instead (ASCII 127 on IBM PCs is displayed as a little house). Alt-2 and Alt-4 EGA/VGA SCREEN MODES. ______________________________________________________________________ Qmodem supports 2 alternate screen modes with EGA/VGA adapter. Alt-2 restores the standard 80x25 video mode for both EGA and VGA adapters. Alt-4 switches EGA systems to 80x43 mode and VGA systems to 80x50 mode. The screen will be cleared following each video mode change. TIP: Some "SuperEGA" or "SuperVGA" adapters also support extended screen modes beyond the standard 80x25 display. These extended modes can be used if they are activated within Qmodem with a F-Key macro which invokes the adapters' setup utility with a @SHELL command. Example: The Video-7 VEGA VGA comes with a utility called ESU.COM used to switch video modes. To run this utility within Qmodem, assign the command "@SHELL ESU 43" to a Qmodem function key via the Alt-J command. Alt-8 HI BIT STRIPPING TOGGLE. ______________________________________________________________________ Some minicomputers or mainframe computer systems use the high (first) bit of each 8-bit character for parity checking (IE.,CompuServe or the Source). If the high bit is not removed, the screen display will consist of high-order ASCII characters (>ASCII 127) such as foreign, graphic, or scientific characters. Version 4.0 173 Alt-8 toggles the stripping of the high-bit ON and OFF. When pressing Alt-8, one of the following status windows will be displayed: ╔════════════════════════════════════════════════╗ ╒══ Status ═══╕ │ Hi-Bit OFF │ ╘═════════════╛ ╒═ Status ══╕ │ Hi-Bit ON │ ╘═══════════╛ ╚════════════════════════════════════════════════╝ Qmodem starts in 8-bit mode by default. This can be changed with a Script command to automate high-bit stripping, for example when calling Compuserve. The Status Line will display an "8" or "7" in the Toggles area to reflect the current mode. Some BBS's use fancy graphics characters and ANSI escape codes. To display these properly, 8 bit mode must be in effect. Alt-9 COPYING TO THE PRINTER. ______________________________________________________________________ The Alt-9 printer session toggle is similar to the DOS Ctrl-PrtSc command. If your system is equipped with a printer, pressing Alt-9 will replicate all screen displays on the system printer. To stop session printing, press Alt-9 again. When pressing Alt-9, one of the following status windows will be displayed: ╔════════════════════════════════════════════════╗ ╒══ Status ═══╕ │ Printer ON │ ╘═════════════╛ ╒══ Status ═══╕ │ Printer OFF │ ╘═════════════╛ ╚════════════════════════════════════════════════╝ 174 Qmodem Operations Manual The printer should be READY when the Alt-9 command is issued. If the system is not equipped with a printer, or the printer is not ready (IE., powered off or offline), Qmodem will display an "Abort or Retry" error status window. Alt-0 LOG FILE TOGGLE. ______________________________________________________________________ The Alt-0 command starts or stops Qmodem Session Log recording. The Qmodem session LOG feature is used to keep track of major Qmodem activity. When the session log is active, Qmodem writes an entry in the session log file reflecting information such as: Who was called The date and time of the call How long the online session Each log entry is time- and date-stamped. Alt-0 is a toggle. If the Log File is closed, a filename prompt will be issued and the file will be opened. If the Log File is already opened, it will be closed. Version 4.0 175 Following is a sample Log File listing: ╔════════════════════════════════════════════════╗ 02:03:06 12-11-88 Connected With : Exec-Net Exec-Mail-Stop 02:03:06 12-11-88 ++ Phone Number : 1-914-667-4759 02:03:06 12-11-88 ++ Comm Speed : 19200-8-N-1 02:03:06 12-11-88 Online Timer Started. 02:04:16 12-11-88 Download File Z:\QMAIL\EXECNET.QWK 02:04:16 12-11-88 ++ Protocol : Xmodem-1K/G 02:06:02 12-11-88 ++ Chars Per Second : 1018 02:06:02 12-11-88 ++ Effective Percent : 106.1 02:06:09 12-11-88 Upload File Z:\QMAIL\EXECNET.REP 02:06:09 12-11-88 ++ Protocol : Xmodem-1K/G 02:06:16 12-11-88 ++ Chars Per Second : 1737 02:06:16 12-11-88 ++ Effective Percent : 180.9 02:06:16 12-11-88 @SHELL Del Z:\QMAIL\EXECNET.REP 02:06:16 12-11-88 ++ @SHELL Successful 02:06:27 12-11-88 Hangup Command entered. 02:06:28 12-11-88 Elapsed Online 00:03:22 12:43:13 12-11-88 @SHELL Qmodem «--» DOS Shell 12:43:40 12-11-88 ++ @SHELL Successful ╚════════════════════════════════════════════════╝ Some Log entries may take up more than one line in the file. Any log entry which starts with "++" is a continuation of the previous one. For example, download or upload log entries are made up of several records in order to record all meaningful statistics. Following is a complete list of all possible Log entries (the time and date stamps are not shown): Key Log entry ----- ------------------------------------------ [user] STAMP [stamp message from Fkey or Script] [auto] Online Timer Started. [auto] Elapsed Online xx:xx:xx Alt-D Connected With : [Board Name] ++ Phone Number : [Board Number] ++ COM Speed : [Speed-Parity-Dbits-Sbits] Alt-H Hangup Command entered. Alt-K COM Port [PortNumber] selected. 176 Qmodem Operations Manual Alt-J New KEY file [KeyFileName]. Alt-L Default Drive now [DriveLetter]: Alt-O Directory changed to [DirectoryPath] Alt-R Dropping to DOS. ++ Drop to DOS Failed. Alt-X Exiting QMODEM. Alt-Y File [Filename] DELETED. PgDn Download File [Filename] ++ Protocol : ASCII ++ Protocol : Xmodem ++ Protocol : Xmodem CRC ++ Protocol : Xmodem Relaxed ++ Protocol : Xmodem-1K ++ Protocol : Xmodem-1K/G ++ Protocol : Ymodem ++ Protocol : Ymodem/G ++ Long block errors : [Number] ++ Short block errors : [Number] ++ SOH errors : [Number] ++ Complement errors : [Number] ++ Block number errors : [Number] ++ Time Out errors : [Number] ++ Resend Block errors : [Number] ++ Checksum errors : [Number] ++ Chars Per Second : [Number] ++ Effective Percent : [Number] ++ Download Aborted. Download Executing [BatchFileName]. ++ External Batch Failure. PgUp Upload File [Filename] ++ Chars Per Second : [number] ++ Effective Percent : [number] ++ Upload Aborted. ++ Using Ymodem-G protocol. ++ Using Xmodem CRC protocol. ++ Using Xmodem protocol. ++ Using Ymodem protocol. ++ Using ASCII protocol. ++ Transfer Successful. External Upload Batch [BatchFileName] ++ External Batch Failure. Version 4.0 177 ^End BREAK signal sent. Entries starting with "[user]" vary depending on the STAMP command used in FKeys and Script commands. Both will begin with the word "STAMP" followed by user-supplied text. Entries starting with "[auto]" are recorded whenever Qmodem changes from offline to online status and vice versa. Remaining entries are related to the command listed in the left column. Since Logging can be turned on automatically, you can now keep a perfect record of all your long distance calls. Many other important functions of operation can also be tracked with the Session Log feature. Alt-5 HOST MODE. ______________________________________________________________________ Qmodem 4.0 Host Mode features the following: o Open, Closed, and Callback operation to implement as little or as much security as needed. o Support of all internal and external file transfer protocols (except ASCII) for both uploads and downloads. o User-customizable menus. Default menus are provided and can be modified or replaced altogether to meet users' requirements. o Full-featured messaging system: Enter/Read/Reply/Kill messages, and Private messaging facility. o Shell to DOS from remote, with optional password protection. o Shutdown from remote, also with optional password protection. o Ability to call Scripts from the Host. New Host features can be implemented via standard Qmodem scripts. o Sysop CHAT mode which allows callers to converse with the SYStem OPerator while online.. o Online listing of the HOST download file directory. 178 Qmodem Operations Manual Host Setup ______________________________________________________________________ Before it can be used, the Qmodem Host Mode must be configured via the Alt-N/H Host Setup. External Files Required ______________________________________________________________________ The Password File, QMHOST.PWD, is the only file required to run Host Mode. QMHOST.PWD contains users' Names, Passwords, Security Levels, and optional CallBack phone numbers. If QMHOST.PWD does not exist, it will be created automatically the first time Host Mode is started. The file "QMHOST.PWD" is a CR/LF-delimited ASCII file. It can be edited with the Qmodem Internal Editor or any standard text editor (IE. QEDIT, Norton Editor, or word processors which can edit unformatted ASCII files). The QMHOST.PWD file layout is as follows: Firstname Lastname Password Security-Level Callback-# ;Comments Each field is separated by one or more spaces, and comments must be preceded by a semicolon. The Callback Number is required only if you have selected the CALLBACK system type. Information in the Password File is case-insensitive("JANE", "Jane", and "jane" are interpreted identically). Following is a sample QMHOST.PWD file: ╔════════════════════════════════════════════════╗ John Friel Password 1 1-319-233-6157 ; Moi Joe Blow Qmodem 0 ; another example Jane Doe Smegma 0 555-1212 ; yet another ╚════════════════════════════════════════════════╝ Records may be in any order (the SYSOP record need not be first). In the example above, the first and last entries have a CALLBACK number and will work in a CALLBACK system, while the second entry will not. Security Levels may be "1" or "0". Level 1 users may shut down the system from remote (as long as they know the password). Other security levels are unassigned and are reserved for future use. Version 4.0 179 Files created by the Host ______________________________________________________________________ Two files are created by the Host the first time it is invoked: QMHOST.HDR The Message Header file. QMHOST.MSG The Message Text File. These two files may not be edited or modified in any way. If they are, unpredictable results will occur while messaging. The message base can be packed (killed messages are deleted) by running the QMHOSTPK.EXE program supplied on the Utilities disk. (Refer to the Message Section for more information on QMHOSTPK.EXE) Optional Files ______________________________________________________________________ Host Menu files can be customized to meet your needs. The following default menu files are supplied with Qmodem 4.0: PRELOG.HST The opening screen sent to all callers MENU.HST The Host Main Menu PROTS.HST The protocol list for Up/Download commands LOGOFF.HST The logoff screen sent to all callers Menu Files are all standard ASCII files and can be edited with the Internal Editor. NOTE: Host Mode supports ANSI color/graphic menus, but these cannot be selectively disabled. If you use ANSI menus, all callers must have ANSI emulation active to correctly view the screens. Included on the Utilities Disk, are sample menu files for you to experiment with. These files all end with the extension .HST . 180 Qmodem Operations Manual Following is a sample MENU.HST file: ╔════════════════════════════════════════════════╗ QMODEM HOST MODE ─────▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄ ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄────── ────────█ File Directory █ █ Enter a Message █──────── ──────────█ Upload a File █ █ Read a Message █────────── ──────────█ Download a File █ █ Page the Sysop █────────── ────────█ Shell to DOS █ █ Open a Script █──────── ─────▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀───── ▄▄▄▄▄▄▄▄▄▄▄ █ Goodbye █ ▀▀▀▀▀▀▀▀▀▀▀ ╚════════════════════════════════════════════════╝ Logging on Locally ______________________________________________________________________ While Host Mode is active, you may press [F1] to log on locally. This feature can be used to test menu and Script operation. All Host commands, except "P", "U" & "D" are available locally. To exit Host Mode, press [ESC] while the system is waiting for a call. You will be returned to TERMINAL mode and the standard Qmodem Initialization string (Alt-N/M/C/I) will be sent to the modem. Starting the Host while ONLINE ______________________________________________________________________ The HOST can be invoked while you are online. The other person you are connected to will be prompted for logon information as if the host had answered the incoming call itself. CAUTION: If the caller is unsuccessful in his logon, the host will drop the connection and cycle. There is no method to return to normal terminal without dropping the connection once the host is started. Sysop Commands while the Host is active ______________________________________________________________________ Host mode assumes that only the SYSOP can logon locally; no password prompt is issued. SYSOP privileges are the same for both local and remote logons. Version 4.0 181 When a caller is online, the SYSOP may break into chat mode by pressing [F2], Dropping to DOS locally by pressing [F5] or disconnect the caller by pressing [F10]. At all times, Host Mode will accept input from the remote caller as well as from the local keyboard. The SYSOP, for example, may come to the rescue of a caller by typing commands directly. These will be processed as if they had been typed by the remote caller. Uploads and Downloads may be cancelled by pressing [ESC] key. It is not considered nice to cancel a download on the 244th block of a 245- block file. Host Functions ______________________________________________________________________ Host Mode features the following sub-systems: 1. File Listing, Uploading & Downloading. 2. Message Entry, Read, Kill. 3. Chat SYSOP-to-caller interaction. 4. Script User-created Host extension(s). 5. DOS Access to DOS from Remote. 182 Qmodem Operations Manual F File List ______________________________________________________________________ The "F" command lists the contents of the Host Download Directory: ╔════════════════════════════════════════════════╗ (60 min. left) Command : U,D,F,R,E,G,O,P,S > F --- FILE LIST --- TESTFILE 24576 14:05 12-12-88 CINKEY.ASM 2048 14:06 12-12-88 COMM.ASM 3072 14:06 12-12-88 COMMIO.ASM 6144 14:06 12-12-88 COMP-CRC.ASM 3072 14:06 12-12-88 CRC.ASM 1024 14:06 12-12-88 DESQVIEW.ASM 2048 14:06 12-12-88 GETCPU.ASM 1024 14:06 12-12-88 GIVEBK31.ASM 5120 14:06 12-12-88 INT1C.ASM 3072 14:07 12-12-88 KBDINT.ASM 5120 14:07 12-12-88 ------ END ------ Press any key to continue... ╚════════════════════════════════════════════════╝ U Upload ______________________________________________________________________ When the Upload command is selected, the Host first looks for the alternate protocol menu file PROTS.HST. If it is found, it is displayed. If not, the list of default protocols is displayed: ╔════════════════════════════════════════════════╗ Protocols available ------------------- X - Xmodem C - Xmodem CRC O - Xmodem-1K Y - Ymodem (batch) F - Xmodem-1K/G G - Ymodem/G (batch) Enter Protocol (Blank to Abort) > _ ╚════════════════════════════════════════════════╝ Version 4.0 183 NOTE: The last two protocols (/G)are available only if CTS checking is selected (Alt-N/O/T/C) and your modem supports hardware handshaking. The caller can then select the desired protocol. A filename prompt will be displayed next for non-batch file transfer. During the transfer, the standard Qmodem Download window will be displayed. NOTE: The meanings of Uploads and Downloads are reversed while in Host Mode -- an Upload by the caller is a Download to the Host, and vice-versa --. D Download ______________________________________________________________________ Download procedures are the same as uploads. Prior to a download, the Host verifies the existence of the file to be sent. If the file does not exist, the Download is cancelled. NOTE: If the filename contains wildcards (* or ?), at least one file must match the file specification or the Download is cancelled. R Reading Messages ______________________________________________________________________ The "R" Read command is used to read messages. Unlike sophisticated Online Services or Bulletin Board Systems, the Qmodem Host mode does not keep track of each caller "Last Message Read". It is up to callers to remember the number of the last message they read. If the caller presses [ENTER] at the "Start with Msg" prompt, the READ command is cancelled and the Main Menu is displayed. If the number entered is lower than the number of the first available message, reading will start with the first available message. Likewise, if the number entered is higher than the highest message number, only the last valid message will be read. 184 Qmodem Operations Manual Following is a sample message-reading session: ╔════════════════════════════════════════════════╗ (60 min. left) Command : U,D,F,R,E,G,O,P,S > R Messages from 1 to 2 Start with Msg # ? 1 Msg# : 1 To : SYSOP (public) From : JOHN FRIEL Subj.: testing 1,2,3... D&T : 12/12/88 14:03:42 ---------------------- this is a test message. testing (R)eply, (K)ill, (Q)uit, [ENTER] next msg > _ ╚════════════════════════════════════════════════╝ Message headers contain Message Number, To, From, Subject, and Date & Time information. Message marked (private) or (killed) can only be viewed by callers with SYSOP Security. After reading a message, the caller is prompted for one of the following actions: 1. (R)eply to the message just read. 2. (K)ill the message. A message can be killed if it was addressed to the caller or the caller has SYSOP privileges. 3. (Q)uit and return to the Main Menu. 4. [ENTER] to read the next message. E Entering a Message ______________________________________________________________________ The "E" command is used to enter a new message. The caller will be prompted for the name of the recipient, an appropriate subject for the message, and the security status of the message (private or public). The actual message is then entered. Messages may have up to 20 lines of 72 characters each. As text reaches the end of the line, it automatically wraps to the next line. Version 4.0 185 Following is a sample message entry session: ╔════════════════════════════════════════════════╗ (120 min. left) Command : U,D,F,R,E,G,O,P,S > E To: somebody else Subject: this is the subject Private (y/n) ? N Enter your message. 72 chars per line, 20 lines max. Autowrap Blank line ends message. --------------------------------------------------------------------------- this is the message bye (C)ontinue, (S)ave or (A)bort > _ ╚════════════════════════════════════════════════╝ At the end of the message, the caller presses [ENTER] twice to terminate message entry. The Host will then display the "(C)ontinue, (S)ave or (A)bort >" prompt. (C) Continue with message entry - The last line with text is displayed with the cursor following the last non-blank character. Use this option if you exited the message and wish to add to it. (S) Save the Message. The message is saved and the user is returned to the Main Menu. If the message was entered as a reply, the next message, if any, will be displayed. (A) Abort the Message. The message is deleted and the user is returned to the Main Menu. If the message was entered as a reply, then the next message, if any, will be displayed. The end-of-message prompt will also be issued automatically when the messages reaches the 20-line maximum. Packing the Message Base ______________________________________________________________________ There is a program called QMHOSTPK.EXE included on the Utilities Disk that will pack the Message base. The term PACK refers to removing 'killed' messages. You execute QMHOSTPK from the DOS prompt. It assumes the message base files QMHOST.MSG and QMHOST.HDR are in the current directory. 186 Qmodem Operations Manual CAUTION: Should the message base become corrupted, the files QMHOST.HDR and QMHOST.MSG files should be deleted and let the host re-create them. F2 CHAT mode ______________________________________________________________________ Pressing [F2] initiates an online chat between the caller and the sysop: ╔════════════════════════════════════════════════╗ (103 min. left) Command : U,D,F,R,E,G,O,P,S > You are now Chatting with the Sysop _ ╚════════════════════════════════════════════════╝ Both caller and sysop may type at will; the display will be identical on both computers. End-of-Line wordwrap is also active in CHAT mode. To exit CHAT mode, the SYSOP must press [F2] again. The message "Returning you to Host Mode" will be displayed and the caller will be returned to the Main Menu. O Open Script ______________________________________________________________________ The Open Script command allows Qmodem script execution while in Host Mode; it is the Host equivalent of the Alt-F command. When the "O" command is selected, the QMHOST.SCR script is executed. NOTE: When logging on locally with the [F1] command, the "O" command invokes the QMHOSTL.SCR script rather than the QMHOST.SCR script. This allows you to test the script offline. Since QMHOSTL.SCR script is executed while offline, it should not test for an online condition. Version 4.0 187 If the Host script is found, it begins executing immediately. If the Script is not found, the following message is displayed: ╔════════════════════════════════════════════════╗ Sorry, that function is not available. ╚════════════════════════════════════════════════╝ Following is a sample QMHOST.SCR: ╔════════════════════════════════════════════════╗ FirstNamePrompt: DISPLAY "Enter your First Name > " ; ask for a first name GETR 0 20 ; put it in $0 IF $Offline Exit1 ; if we are offline, then exit IF "$0" <> "" LastNamePrompt ; If so, go to the next prompt. DISPLAYLN "Hey, I want your Last name! Try again...^M^J" GOTO FirstNamePrompt LastNamePrompt: DISPLAY "Enter your Last name > " ; ask for a last name GETR 1 20 ; put it in $1 IF $Offline Exit1 ; are we offline? if so, exit IF "$1" <> "" NextStep ; if a name was entered, go to next label DISPLAYLN "Hey, I want your Last name! Try again...^M^J" GOTO LastNamePrompt NextStep: ; continue here DISPLAYLN " " DISPLAYLN "Thank you, $0" DISPLAYLN "You will now be returned to the Host... DISPLAYLN " " DISPLAYLN "Please wait $0 $1" Exit1: EXIT ; exit back to the Host ╚════════════════════════════════════════════════╝ 188 Qmodem Operations Manual NOTE: The QMHOSTL.SCR version of the script would be modified as follows: ╔════════════════════════════════════════════════╗ FirstNamePrompt: DISPLAY "Enter your First Name > " ; ask for a first name GET 0 20 ; put it in $0 IF "$0" <> "" LastNamePrompt ; If so, go to the next prompt. DISPLAYLN "Hey, I want your Last name! Try again...^M^J" GOTO FirstNamePrompt LastNamePrompt: DISPLAY "Enter your Last name > " ; ask for a last name GET 1 20 ; put it in $1 IF "$1" <> "" NextStep ; if a name was entered, go to next label DISPLAYLN "Hey, I want your Last name! Try again...^M^J" GOTO LastNamePrompt NextStep: ; continue here DISPLAYLN " " DISPLAYLN "Thank you, $0" DISPLAYLN "You will now be returned to the Host... DISPLAYLN " " DISPLAYLN "Please wait $0 $1" EXIT ; exit back to the Host ╚════════════════════════════════════════════════╝ NOTE: The GETR command was changed to GET, and the $OFFLINE tests were removed completely. TIP: The callers First and Last name is passed to the script variables $0 and $1 respectively. For more information on Qmodem Scripts, refer to the Script Language section later in this manual. Version 4.0 189 S Shell to DOS ______________________________________________________________________ The "S" Shell to DOS command allows access to the DOS prompt while Host Mode is active. This command is the Host equivalent of the Alt-R command, and similar rules and restrictions apply. There is, however, one major difference between the local DOS Shell available with the Alt-R command, and the Host Shell. In the case of a remote logon, DOS must receive its input from the serial port, rather than from the keyboard. If there is a user online, the Host Shell invokes the QMHOST.BAT batch file. If it is a local Sysop logon, then the Shell operates in the same manner as the Alt-R command. Included on the Utilities Disk is a program called QMHOST.EXE that handles the required DOS-to-Serial Port protocol. This program and the Host Shell batch file QHOST.BAT are included on the Utilities Disk. QMHOST.EXE allows you to run any program that uses the STDIN and STDOUT DOS calls to display information on the screen and read from the keyboard. If you try to run a program that writes directly to video memory, the caller will not see the information displayed by the program. The ANSI.SYS device driver is required to run the QHOST.EXE program. Make sure this is included in your CONFIG.SYS file. Also, the Utilities Disk contains a program called ANSIPAT.EXE which will patch the ANSI.SYS driver for proper operation. The purpose of ANSIPAT.EXE is to patch your ANSI.SYS so that it will do a BIOS call instead of a direct screen write, making it more compatible with QHOST. You will need to run this program in the subdirectory that your ANSI.SYS resides in. It will copy ANSI.SYS over to ANSI.BAK then search the ANSI.SYS for the code which scrolls the screen. If it finds the erroneous code, it will replace it with the appropriate screen scroll BIOS call. If it doesn't find the appropriate code, ANSI.SYS will remain unchanged. NOTE: You will have to reboot the computer for the new ANSI.SYS to take effect. QMHOST always watches the Carrier Detect signal from the modem. If a loss of carrier is detected, QMHOST immediately returns to the Host. To return normally, the caller types "EXIT" from the DOS prompt. 190 Qmodem Operations Manual The Qmodem Script Language: an Introduction What is a script? ______________________________________________________________________ A script is a Qmodem program, designed to perform specific and/or repetitive functions much faster and more reliably than with manual methods. Scripts can be used to do just about anything that can be done at the keyboard; your imagination is the only limit. Common uses for scripts include: o Automated logon o File transfers o Completely automated sessions o Unattended Qmodem operations The Qmodem QuickLearn Script Recorder is an extremely convenient facility, but it has its limitations. Basically, QuickLearn can only record your interactions with a remote computer and replicate them exactly. It cannot add decision-making logic to the scripts it creates, or account for unexpected or changing conditions. When you run out of QuickLearn power, time has come to write or edit your own scripts. Scripts are similar to interpreted BASIC programs. The syntax is somewhat different, but the principles are almost identical. The Qmodem Script Interpreter (also referred to as the Script Parser) reads the script's code and executes the instructions as it reads them. Scripts can be very simple or extremely involved. Logon scripts created by QuickLearn are simple. Some large and complex scripts have also been written to turn Qmodem into a mini-Bulletin Board System. With the advent of BBS Networks such as InterLink, scripts have been written to automatically dial a BBS, log on, open a mail transfer door, download a mail packet, and log off. Many useful Qmodem scripts are included on the Qmodem Utilities disk. Many other scripts can be found on bulletin boards, including the Forbin Project, Home of Qmodem. You need not be a programmer to write scripts, but if you aren't, we recommend that you start at the beginning until you have a good understanding of script concepts, syntax rules, and common script commands. As with all programming languages, The Qmodem script language has a few idiosyncracies. Here are some of the most obvious. Version 4.0 191 Physical vs. Logical Screen ______________________________________________________________________ The physical screen is the entire screen, which usually consists of 80 columns and 25 lines (or more if you have an EGA or VGA and use one of the extended display modes). Smaller, logical screens can be defined with the script BOX or WINDOW commands. All screen output commands except ATWRITE are limited to the logical screen boundaries defined in the last BOX or WINDOW commands. Input and Output Commands ______________________________________________________________________ The script language has a wealth of input and output commands, each with a specific purpose. For example, there are six commands available to read input from the keyboard and/or COM port (GET, GETN, GETR, GETNR, GETX, and INKEY), and seven commands available to display data on the screen and/or send it to the COM port (ATWRITE, SEND, DISPLAY, DISPLAYLN, NOTE, WRITE, and WRITELN). In addition, the WHEN command can also be used to send data to the COM port when specific COM input is received. Variable Handling ______________________________________________________________________ Variables used in scripts do not have explicitly declared types such as INTEGER or STRING. The string "100", for example, could be used as a numeric variable as well as a text variable. It is your responsibility to insure that the variable contents are numeric when they need to be. When a variable name is prefixed with a dollar sign, the Script Interpreter will automatically substitute its value in the command. When a value is assigned to a string, the dollar sign is omitted. It is important to understand this concept to put it to good use. Regardless of their contents, script variables cannot exceed 64 characters. Script variables are stored in an area of memory reserved for their use. This memory is allocated in the Alt-N/M/S Setup menu. 192 Scripts Operation Manual Running Scripts ______________________________________________________________________ Scripts may be invoked explicitly with the Alt-F command. They may also be run automatically by specifying a script name on the Qmodem command line, or if the script name is defined in a directory entry (Linked Scripts), in which cse the script will start executing when the connection is made. Script Commands ______________________________________________________________________ The Qmodem script language is very comprehensive. Almost all terminal mode manual commands are available as script commands (and then some). Since equivalent script commands perform the same functions as their manual counterpart, we also recommend that you familiarize yourself with the manual commands first; its documentation more thorough and we did not see the need to duplicate it for the script command. Commands that are unique to the script environment are covered in detail, however. Script Language ______________________________________________________________________ The script language is a programming language, and script files are special Qmodem programs intended to perform specific functions. If you are not a programmer, do not let this intimidate you. The script language is easy to learn, and scripts are easy to read and modify. Error messages are clear and concise. The built-in debugger and Qmodem Editor will help you along as you develop your scripts, in the unlikely event you make a mistake. Scripts can be very flexible. They can be used in many ways that aren't described here. Scripts fall into one of four categories: 1. Linked scripts, These scripts are physically named in entries in the Qmodem Phone Directory. When connection is made, the script is executed automatically. The same script can be linked to multiple entries. These scripts are often referred to as "Logon Scripts", because they take control immediately after a connect and usually automate boring and repetitive logon processes. Examples: There are two local Tymnet phone numbers in your phone directory. The script SOURCE-U.LOG can be linked to both numbers to automate the logon to The Source. Version 4.0 193 A BBS system has three nodes with different phone numbers. A single script like RBBS.LOG can be linked to all three numbers. 2. Scripts started with the Alt-F command, which require execution- time parameters. Qmodem allows up to ten variable parameters to be passed to a script. 3. Scripts linked to Function Keys. Because they are stored in a Function Key Macro, you do not have to re-enter the parameters each time you run the Script. 4. Stand-alone Scripts, requiring no parameters. These scripts can be executed automatically when Qmodem is started, by specifying their name in a command-line parameter. Example: To execute the script DOFIRST.SCR when starting Qmodem, use the command: C>QMODEM /S=DOFIRST.SCR<cr> Once initialization is complete, Qmodem will load and execute the script whose name was specified in the /S= command-line parameter. This command line could be contained in a BATCH file to automate the process even further. How to Create and Name a Script ______________________________________________________________________ Any standard ASCII text editor or word processor can be used to create a script file. You may save scripts under any file name and extension, but using the ".SCR" file extension makes life much easier, as we'll see later. The easiest way to write a script is to let Qmodem do it for you! Refer to the Alt-Q (QuickLearn) command for complete details. But, if you insist on doing it yourself with your favorite Word processor or Editor, remember these tips: 1. Scripts must be saved as standard, CR/LF-delimited ASCII files. Non-ASCII files like those produced by WordStar's Document mode won't work (for WordStar, use N at the opening prompt to create scripts in the Non-Document mode). 2. Each Script command must be on a separate line in the file. 194 Scripts Operation Manual TIP: We recommend the Qmodem Internal Editor for creating and editing scripts. Refer to the Alt-V and Alt-J/@EDIT commands for information on the internal editor. Starting a Script ______________________________________________________________________ There are 3 ways to start a Script: 1. The command line switch /S= to "auto start" a script. Refer to the Command Line Switches for a description. 2. The explicit Alt-F command to call a script. 3. Automatic execution of a Linked-Script attached to a Phone Directory entry. (See Alt-D for instructions on attaching a script to a dialing directory entry) Stopping a Script ______________________________________________________________________ You can stop a script at any time by pressing the [ESC] key. The Qmodem status line will change to the following: ╔════════════════════════════════════════════════╗ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ [S] Single-step [T] Trace [G] Go [A] Abort ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒ ╚════════════════════════════════════════════════╝ To cancel the script, press "A". Pressing "G" resumes script execution at the point where it was interrupted. The "S" and "T" commands are used to start Script Debug Mode (more on this later). NOTE: Pressing "Y" will also Abort the script to provide backward compatibility with previous releases of Qmodem. Debugging a Script ______________________________________________________________________ Qmodem includes a powerful script debugger, complete with single-step and trace/animate features. In addition, if a script fails, the Qmodem Internal Editor can be automatically invoked with the cursor positioned at the exact point where the error was detected. Version 4.0 195 Following is a simple script example to illustrate the debugger's operation: ; ; Script example ; DISPLAYLN "this is the value of variable COUNTER : $COUNTER " EXIT The fourth line in the script refers to a variable called $COUNTER. This variable was not defined, and an error will result. Executing the script will cause the following window to be displayed: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════ Script Error! ═════════════════════════════╕ │Type : Invalid Substitute VARIABLE │ │File : D:\QMODEM\SCRIPTS\TEST1.SCR │ │Row : 4 │ │Col : 52 │ │Line : DISPLAYLN "this is the value of variable COUNTER : $COUNTER " │ │ │ │Press any key to Edit file │ ╘═════════════════════════════════════════════════════════════════════════╛ ╚════════════════════════════════════════════════╝ The first line describes the error (explained in detail in the next section). In this case, we have used an invalid variable. The second line shows the fully qualified script filename. The third and fourth lines show the Row (line) and Column number in the script file where the error occurred. The fifth line is the actual script line in which the error occurred. 196 Scripts Operation Manual The bottom line displays an edit prompt. Assuming that we are using the Qmodem Internal Editor, pressing a key yields the following display: ╔════════════════════════════════════════════════╗ ╒══════════════════════════════ Full Screen Edit ══════════════════════════════╕ │ Line 4 Col 52 Insert Indent D:TEST1.SCR │ │; │ │; Script example │ │; │ │DISPLAYLN "this is the value of variable COUNTER : $COUNTER " │ │EXIT | │ │ +-(cursor is located here) │ │ │ ╘══════════════════════════════════════════════════════════════════════F1 Help═╛ ╚════════════════════════════════════════════════╝ When using the Qmodem Internal Editor, the cursor will be positioned under the $ in $COUNTER, which is the offending variable name. Two additional error conditions yield different Script Error windows: ╔════════════════════════════════════════════════╗ ╒═════════════════════════════ Script Error! ═════════════════════════════╕ │Type : LABEL not found │ │ TIMEOUT LABEL = ENDOFSCRIPT │ │File : D:\QMODEM\SCRIPTS\Test1.SCR │ │ │ │ │ │ │ │Press any key to Edit file │ ╘═════════════════════════════════════════════════════════════════════════╛ - or - ╒═════════════════════════════ Script Error! ═════════════════════════════╕ │Type : LABEL not found │ │ GOTO/GOSUB LABEL = ENDOFSCRIPT │ │File : D:\QMODEM\SCRIPTS\Test1.SCR │ │ │ │ │ │ │ │Press any key to Edit file │ ╘═════════════════════════════════════════════════════════════════════════╛ ╚════════════════════════════════════════════════╝ Version 4.0 197 In both examples, identifying labels were not found in the script. So far, we have seen the automated debugger at work. An error occurs, and you are immediately notified of it. Qmodem also features an Interactive Debugging mode, in which YOU are in control. To start the interactive debugger, the DEBUG ON command is used. Following is an example of interactive debugging: ; ; Script example ; DEBUG ON ; turn on the debugger STRING ONE TWO THREE ; define 3 new variables ASSIGN ONE "1" ; give them numeric values ASSIGN TWO "2" ASSIGN THREE "3" DISPLAYLN " ONE = $ONE, TWO = $TWO, and THREE = $THREE" EXIT When the script is executed, the status line will change to: DEBUG << >> In interactive debug mode, the next script line to be executed is displayed between the << >> characters. To execute the statement, press the SpaceBar. In the example, the first line following the DEBUG command is blank, and no text appears between the << >>. Pressing the SpaceBar yields the following series of DEBUG status displays: ╔══════════════════════════════════════════════════╗ DEBUG <<STRING ONE TWO THREE >> DEBUG <<ASSIGN ONE "1" >> DEBUG <<ASSIGN TWO "2" >> DEBUG <<ASSIGN THREE "3" >> DEBUG <<DISPLAYLN " ONE = $ONE, TWO = $TWO, and THREE = $THREE" >> ╚══════════════════════════════════════════════════╝ 198 Scripts Operation Manual A number of useful debug commands are available while single-stepping through a script. Pressing the F1 key displays a summary of these commands on the status line: ╔══════════════════════════════════════════════════╗ [SPACE] Next [T] Trace [G] Go [S] Subst. Line [O] Orig. Line [U] Under ╚══════════════════════════════════════════════════╝ After the command summary line has been displayed for approximately 2 seconds, the status line reverts back to the standard DEBUG display. Interactive Debug commands include: [SPACE] Next Pressing the SpaceBar executes the line displayed between the << >> characters. [T] Trace Pressing "T" starts executing the script at the rate of 2 lines per second (Animate Mode). [G] Go Pressing "G" terminates interactive debug mode and resumes script executing with the next line. The script will execute until it ends normally, an error occurs, or another DEBUG ON command is found. [S] Subst. Line Pressing "S" displays (substitutes) the values of all variables in the current script line prior to execution. [O] Orig. Line Pressing "O" terminates variable substitution and re-displays current line in its Original form. [U] Under Pressing "U" temporarily suspends display of the Debug status line when running the script in full-screen mode and the normal status line itself is disabled (Alt-N/O/T/T OFF). Version 4.0 199 Going back to our script example, pressing "S" yields the following display: ╔══════════════════════════════════════════════════╗ DEBUG <<DISPLAYLN " ONE = 1, TWO = 2, and THREE = 3" >> ╚══════════════════════════════════════════════════╝ pressing [SpaceBar] again... ╔══════════════════════════════════════════════════╗ DEBUG <<EXIT >> ╚══════════════════════════════════════════════════╝ pressing [SpaceBar] again... Returns us to the normal status line following the end of the script. Special Characters in Scripts ______________________________________________________________________ In scripts, the caret (^) is used as a modifier when combined with certain other characters: ^~ A caret-tilde (~) combination generates a 1/2 second delay. ^^ A double-caret sequence yields a single-caret character. To insert CONTROL characters in your scripts, prefix the letter with the ^ (caret). 200 Scripts Operation Manual Following is a list of valid control (ctrl) characters and the corresponding caret combinations: ╔ Dec Hex Ctrl ╗ ╔ Dec Hex Ctrl ╗ ║ 0 00 ^@ ║ ║ 16 10 ^P ║ ║ 1 01 ^A ║ ║ 17 11 ^Q ║ ║ 2 02 ^B ║ ║ 18 12 ^R ║ ║ 3 03 ^C ║ ║ 19 13 ^S ║ ║ 4 04 ^D ║ ║ 20 14 ^T ║ ║ 5 05 ^E ║ ║ 21 15 ^U ║ ║ 6 06 ^F ║ ║ 22 16 ^V ║ ║ 7 07 ^G ║ ║ 23 17 ^W ║ ║ 8 08 ^H ║ ║ 24 18 ^X ║ ║ 9 09 ^I ║ ║ 25 19 ^Y ║ ║ 10 0A ^J ║ ║ 26 1A ^Z ║ ║ 11 0B ^K ║ ║ 27 1B ^[ ║ ║ 12 0C ^L ║ ║ 28 1C ^\ ║ ║ 13 0D ^M ║ ║ 29 1D ^] ║ ║ 14 0E ^N ║ ║ 31 1F ^_ ║ ║ 15 0F ^O ║ ╚══════════════╝ ╚══════════════╝ TIP: Control characters are case-insensitive: ^C is the same as a ^c. NOTE: To generate the double-caret ^^ character in the internal editor, first type ^P, then type ^^. The editor will display a "^" in the same colors as the header line rather then normal text colors. This is normal and is used to represent an imbedded Ctrl character. Comments may be added to scripts, and must be preceded by a semi-colon (;): ; A semicolon as the first character is always a comment WAITFOR "Enter your password :" ; This is a comment SEND "$Password^M" ; another comment line PASSWORD1: ; a comment after a label Comments are not displayed during script execution. TIP: Make it a habit to add comments to your scripts wherever and whenever possible. Comments are an invaluable help when debugging or making changes to scripts, especially older, long-forgotten ones. Version 4.0 201 Definitions and Parameters ______________________________________________________________________ Script statements usually consist of an operation code and one or more operands or parameters. Parameters shown in brackets [ ] are optional. Parameters in quotes (" " or ' ') are mandatory. For example: DIAL "1" DIAL 'TSalt-Air' Single- and double-quote characters should not be mixed except in special cases. For example, to send the following message: John said, "Qmodem is the BEST!" you would code the following: SEND 'John said, "Qmodem is the BEST!"' Single- and double-quote characters are interchangeable, but must be used in matched pairs. As shown above, use of one set of quote characters allows you to include the other as part of a text string. To send the following string: John's password is QMODEM the script code would be: SEND "John's password is QMODEM" Labels ______________________________________________________________________ Labels define the targets of EXIST, GOTO, GOSUB, IF and WHEN commands. All labels must end with a colon. Below are some examples of valid script labels: EXIT_LABEL: A: A_LONG_LABEL: A_much_longer_label_than_the_others: Labels must appear on a line by themselves. Comments are the only other statements allowed on label lines. 202 Scripts Operation Manual Pre-defined String Variables ______________________________________________________________________ The variables $0 through $9 are pre-defined and may be used anywhere in place of user-defined string variable. In addition, variables $0- $9 must be used if data is to be passed to the script in the form of parameters in the Alt-F command or F-key macros. String variables may not exceed 64 characters in length. The variables $0-$9 can be set with the ASSIGN, GET, GETR, GETN, GETNR and GETX commands. For example, the statement: ASSIGN 0 "This is a test" store the text string: This is a test into variable $0. Since string variables are replaced with their actual values before script commands are executed, the leading $ is omitted when one of the pre-defined string variables is the first operand in an ASSIGN statement. The following examples further illustrate this principle: ASSIGN 0 "Qmodem is the Best!" ;$0 becomes the quoted string ASSIGN 1 $0 ;$1 is set to $0 And the statement: SEND "$1" ;the string $1 is sent would send the following string to the modem: Qmodem is the Best! Script commands can actually be stored into string Variables with an ASSIGN command, and used later in the script. For example: ASSIGN 0 "WAITFOR " ;$0 = WAITFOR[space] $0 "Password " would be interpreted as: WAITFOR "Password " Version 4.0 203 If a dollar sign ($) is required as part of a text string, that character must be duplicated. For example: SEND "This is a dollar sign : $$" will send the following: This is a dollar sign : $ String variables are very powerful tools indeed! With their flexible text and command substitution features, what can be done with them is only limited by your own imagination. The next section of the manual describes Qmodem's script commands in detail. Commands are listed in alphabetical order, and appropriate coding examples are included for each command. System Variables ______________________________________________________________________ Most of Qmodem's environment and operating parameters are stored in pre-defined, read-only variables which are available during script execution. NOTE: Pre-defined variables may not be the target of ASSIGN, GET or INKEY commands. $DATE The $DATE variable contains the current system date, based on the PC's internal clock. The date is returned as an 8-character string in MM/DD/YY format. On April 15, 1989, the command: SEND "$DATE" would send the string "04/15/89" to the modem. $TIME The $TIME variable is similar to the $DATE variable. The time is stored as an 8-character string in the HH:MM:SS format, and uses a 24- hour clock (IE, military time). 204 Scripts Operation Manual At 3:52:07 PM, the command SEND "The time is $TIME" would yield: The time is 15:52:07 $LAST_ROW The $LAST_ROW variable contains the number of the last line on the screen, not including the Status Line. For example, on an 80x25 screen, this variable contains the value 24. $LAST_COL The $LAST_COL variable contains the physical screen width, in columns. On a 25x80 screen, this variable contains the value 80. $ATTR The $ATTR variable contains the screen's current Color Attribute. In a script which changes the screen color, this value may be saved at the beginning of the script, and restored before the script terminates to re-establish the normal default screen color. $DLPATH This contains the Download Path as specified in the Alt-N/D/D Setup variable. You could use this to point to the download directory when using the DOWNLOAD script command. $ULPATH This contains the Upload Path as specified in the Alt-N/D/U Setup variable. It could be used in combination with the UPLOAD script command. $SCPATH This is the Script Directory Path as specified by the Alt-N/D/S Setup variable. All temporary scripts should be stored in this directory. Version 4.0 205 Connect Information Variables ______________________________________________________________________ Qmodem stores information relating to the last successful connection (or the current one, if ONLINE) in a series of variables. For information to be valid, the connection must have been established through a standard DIAL command or a linked script. $BOARD The $BOARD variable contains the name field of the directory entry to which Qmodem was last successfully connected. This is a variable- length string which does not exceed 34 characters. If you use the default Qmodem Phone Directory, the commands: DIAL "1" ;dial the first phone book entry NOTE Connected to $BOARD! ;display a connect msg will display: Connected to The Forbin Project PCBoard! $NUMBER The $NUMBER variable contains the phone number of the last connected entry, as shown in the dialing directory. Using the same example: NOTE Connected to $BOARD at $NUMBER. will display: Connected to The Forbin Project PCBoard at 1-319-233-6157. $PASSWORD The $PASSWORD variable contains the password field for the last connected entry, as stored in the dialing directory. $PASSWORD can be used in a generic logon (linked) script for BBSs running the same software. The following example will operate with PCBoard systems: 206 Scripts Operation Manual NOTE Connected to $BOARD ;display after connection WAITFOR "Graphics" ;wait for first prompt SEND "N^M" ;send a "N[ENTER]" WAITFOR "First name" ;wait for the name prompt SEND "FIRST;LAST^M" ;send your name WAITFOR "Password" ;wait for password prompt SEND "$PASSWORD^M" ;send the linked password $SCRIPT The $SCRIPT variable contains the name of the linked script for the connected entry, as stored in the dialing directory. Using the above example, we could add another line as follows: NOTE This is script $SCRIPT which would display: This is script PCBOARD.SCR $PROTOCOL The $PROTOCOL variable contains the default file transfer protocol assigned to the connected entry. It is used in SEND strings or script DOWNLOAD commands, as illustrated in the following example, which sends a file download request to a PCBoard BBS, waits for the start- of-transfer prompt, and starts the actual download: SEND "D $PROTOCOL FILENAME.ARC^M" WAITFOR "[ctrl-X] to abort" DOWNLOAD $PROTOCOL FILENAME.ARC $SPEED The $SPEED variable contains the current serial rate (IE., 300, 1200, 2400, 9600 etc...). The serial baud rate is set by the by the redialer before each number is dialed. If you are connected at 2400, the following command: NOTE Connected at $SPEED this time will display: Connected at 2400 this time Version 4.0 207 NOTE: The baud rate may not be reset, depending on the state of the "Redialer Set Baud Rate" toggle in the Alt-N/O/T Setup menu. $COM The $COM variable contains the remainder of the communication parameters, in the form of Databits-Parity-Stopbits. If your current settings are No parity, 8 data bits, and one stop bit, and your serial rate is 2400, the command: NOTE Connected at $SPEED-$COM will display: Connected at 2400-8-N-1 $NOTEFILE This is the full DOS filename for the Attached Note file. Each entry has a unique Note file that can store information. Using this variable in combination with the text IO Script commands (OPENFILE, READFILE, CLOSEFILE), you can store remote computer specific information and load it every time you call that system. Example Script SHOWNOTE.SCR: ╔════════════════════════════════════════════════╗ EXIST $NOTEFILE CONT ;see if it exists DISPLAYLN "No attached notes" ;nope, say so RETURN ;exit back to logon script CONT: DISPLAYLN "Contents of attached Note file:" DISPLAYLN "-------------------------------" OPENFILE $NOTEFILE READ ;open the note file READLOOP: READFILE 0 ;read IF "$0" = "_EOF_" DONE ;if end-of-file, jump to DONE DISPLAYLN "$0" ;display the line GOTO READLOOP ;go back and read some more DONE: CLOSEFILE ;close the note file RETURN ;return back to the logon script ╚════════════════════════════════════════════════╝ 208 Scripts Operation Manual This script simply opens the attached Note file and displays the contents. To activate it, just use the SCRIPT command to call this as a subroutine: ╔════════════════════════════════════════════════╗ ; ; QuickLearn Script generated at 02:35:18 on 08-22-88 ; May require editing before use. ; NOTE Attached Note File is : $NOTEFILE ;if you're curious SCRIPT SHOWNOTE.SCR ;now show it ;rest of the auto-logon script ╚════════════════════════════════════════════════╝ Script Commands ______________________________________________________________________ General Coding Information Script commands usually consist of an Operation Code, often referred to as OpCode, and one or more Operands, also referred to as arguments, targets, or parameters. Opcode and operands are separated with spaces. In certain cases, a relational operator may separate parameters. For example, the script IF command has two operands separated by a relational operator: IF "$0" = "$1" ROUTINE IF is the OpCode, "$1", "$2" and ROUTINE are the operands, and = is the relational operator. In the example, the command compares the contents of variables 0 and 1, and branches to ROUTINE if they are equal. Operands fall in one of the following categories: EXPNUM: explicit numeric values. As with numeric variables, these values must be integers in the range 0-32,767. For example, in the command: WINDOW 1 1 25 80 1 1 25 and 80 are explicit numeric values. Version 4.0 209 KEYWORD: keywords are reserved words defined internally in the script language. For example, all modem system variables and TURNON/TURNOFF parameters are keywords which may not be used as variable names for any other purpose. LABEL: labels identify the beginning of a routine in a script. They are normal words followed by a colon. They are used as parameters in explicit GOTO and GOSUB statements, or implicitly in IF, WAITFOR and WHEN statements: IF "$0" = "$1" ROUTINE . . . ROUTINE: . . if variable 0 is equal to variable 1, branch to the label called ROUTINE. GOTO MYPARTY . . MYPARTY: . . branches unconditionally to the label MYPARTY. NUMVAR: numeric variable. All numeric values and variables used in scripts must be positive integers, and their value may not exceed 32,767. Numeric variables are not defined explicitly; the same variable may be used for the storage of text or numeric data. It is the user's responsibility to insure that the variable contains numeric data when required. STRING: a string is an element of text delimited by quotes. Strings may contain imbedded blanks. In the example: ASSIGN 0 "This is text" "This is text" is a string. WORD: a self-delimiting alphanumeric value not bound by quotes, and not containing imbedded blanks. A word can also be defined as a string without blanks and without quotes. In the example: 210 Scripts Operation Manual ASSIGN 0 THISISAWORD THISISAWORD is a word variable. The command: ASSIGN 0 "THISISAWORD" is functionally identical to the previous one. Script Command Reference ______________________________________________________________________ Following is a complete description of all available script commands. Each command is documented in an easy-to-understand format: Function A brief description of the command. Declaration A concise description of the command's syntax. Remarks A more detailed description of the command, including parameters and their values, and how the command interacts with the rest of the script and the system in general. Restrictions , limitations, or warnings that apply to the command or its parameters. If the command has no restrictions, this section will be omitted. See also Related script commands. Example Limited Coding example. For in-depth script examples, refer to the Utilities Disk. Version 4.0 211 ______________________________________________________________________ ATWRITE ______________________________________________________________________ Function Display a text string anywhere on the screen. Declaration ATWRITE COL ROW ATTRIBUTE STRING Remarks COL, ROW and ATTRIBUTE are explicit numeric values or variables. ROW and COL must be valid screen coordinates and are not restricted to the values set by the WINDOW and BOX commands. ATTRIBUTE must be in the range 0-255. The COLOR command gives a complete description of Color Attributes and how to compute them. See also COLOR 212 Scripts Operation Manual Example ATWRITE 1,1,15,"This is a test" ;put the msg in the ;upper left corner in ;high intensity white ;on a black background ATWRITE 1 24 30 "$0" ;write the text in variable $0 ;on the last line using yellow ;on a blue background ______________________________________________________________________ ASSIGN ______________________________________________________________________ Function Store a value into a variable. Declaration ASSIGN VARIABLE WORD|STRING Remarks This command stores the contents of a word or string into VARIABLE. The $ variable prefix is not used in order to prevent value substitution during script parsing. If the string contains embedded quote characters, use the other quote character (IE., single ' and double " quotes) to enclose the string. See also STRING Example ASSIGN 0 TEST ;sets $0 to "TEST" ASSIGN 0 "Test string" ;sets $0 to "Test string" ASSIGN 0 $1 ;sets $0 to equal $1 ASSIGN THIS "John's Wife is Kathy" ASSIGN THAT "$THIS" ;needs quotes because of ;spaces and quote embedded in ;$THIS ______________________________________________________________________ BEEP ______________________________________________________________________ Function Produce a sound through the speaker. Declaration BEEP TONE Remarks TONE is an explicit numeric value or variable and specifies the frequency in Hertz (cycles/sec).. The sound lasts approximately 1/5 sec. Multiple BEEP commands may be grouped together to produce more meaningful sounds (IE., alarms). If TONE is non-numeric, an error occurs. Version 4.0 213 Example BEEP 1200 ;a 1200 Hz tone BEEP 1400 ;a 1400 Hz tone STRING TONE ;define a new variable called TONE GET TONE 4 ;prompt for the value of TONE ;no check is made for invalid data BEEP $TONE ;beep at $tone Hz ______________________________________________________________________ BOX ______________________________________________________________________ Function Draw a Box on the screen and set the logical screen dimensions. Declaration BOX C1 R1 C2 R2 Remarks This command is used to define an on-screen logical window. The window is defined by its upper left corner at row R1, column C1, and its bottom right corner at row R2, column C2. Row and column values must be explicit numeric values or variables, separated by spaces or commas. After a BOX or WINDOW command, the output of screen display commands (except ATWRITE) is restricted to the area defined in the BOX command. Coordinates values are not verified; you must insure that C2>C1, R2>R1, and all four values are valid screen locations. The upper left corner of the screen is at coordinates 1,1. See also WINDOW, GETSCR, PUTSCR Example BOX 1,1,80,24 ;opens a window the full size of ;the screen. BOX 20,4,60,8 ;opens a window 40 cols wide by ;4 lines high. BOX 20 4 60 8 ;same as above without comma ;delimited. TIP: If you have an EGA or VGA display, the lower right corner may vary with the screen dimensions (See Alt-2 or Alt-4). ______________________________________________________________________ BREAK ______________________________________________________________________ Function Send the UART BREAK signal. Declaration BREAK 214 Scripts Operation Manual Remarks The BREAK command sends the UART Break signal for 1.5 seconds. BREAK is the script equivalent of the Ctrl-End command. Example BREAK ;send the Break signal ______________________________________________________________________ CAPTURE ______________________________________________________________________ Function Open a File to capture all terminal I/O. Declaration CAPTURE FILENAME Remarks The filename should be a fully qualified, valid DOS filename. FILENAME must be a word or string variable. If the drive and path are omitted, the current drive:\path is assumed. If the file exists, data will be added to the end of it (appended). If the file does not exist, it will be created. To close the capture file, use the TURNOFF CAPTURE command. CAPTURE is the script equivalent of the Ctrl-Home command. See also TURNOFF Example CAPTURE C:\QMODEM\TEXT\CAPDATA.DAT CAPTURE THISFILE.DAT ;in the current directory TURNOFF CAPTURE ______________________________________________________________________ CHDIR ______________________________________________________________________ Function Change to a new Drive:\Directory. Declaration CHDIR DIRECTORY Remarks This command is used to change the default DOS directory to that specified in the DIRECTORY variable. DIRECTORY must be a word or string variable. If a new drive specification is included in the DIRECTORY variable, the current drive will also be changed. CHDIR is the equivalent of the Alt-O command (and of the Alt- L command if the drive is changed). Version 4.0 215 See also DRIVE Example CHDIR \ ;change to the root directory CHDIR C:\QMODEM ;change to C:\QMODEM DISPLAY "Enter the new directory ? " ;a prompt GET NEWDIR 64 ;get the new directory CHDIR $NEWDIR ;and do the change ______________________________________________________________________ CLOSEFILE ______________________________________________________________________ Function Closes the currently open TEXT file. Declaration CLOSEFILE Remarks The CLOSEFILE command closes the file opened by the OPENFILE command. For a complete explanation, see the OPENFILE command. See also OPENFILE, READFILE, WRITEFILE Example OPENFILE TEXT.DOC READ ;open text.doc for reading READFILE 0 ;read the first line into $0 CLOSEFILE ;close the file ______________________________________________________________________ CLRSCR ______________________________________________________________________ Function Clear the logical screen. Declaration CLRSCR Remarks CLRSCR clears the current active window. If a WINDOW or BOX command has not been issued, the entire screen is cleared. CLRSCR is the script equivalent of the Alt-C command. See also BOX, WINDOW Example CLRSCR ;clear the screen BOX 1 1 80 14 ;open a window on the screen CLRSCR ;clear the window WINDOW 1 1 80 24 ;define the "full screen" CLRSCR ;clear the whole screen 216 Scripts Operation Manual ______________________________________________________________________ COLOR ______________________________________________________________________ Function Defines the color of displayed text. Declaration COLOR ATTRIBUTE Remarks This command sets both foreground and background colors with a single attribute. ATTRIBUTE is an explicit numeric value or variable. The following values are needed to compute the color attribute: 0 Black 8 Dark Gray +128 Blink 1 Blue 9 Light Blue 2 Green 10 Light Green 3 Cyan 11 Light Cyan 4 Red 12 Light Red 5 Magenta 13 Light Magenta 6 Brown 14 Yellow 7 Light Gray 15 White Foreground colors may be 0 thru 15; background colors may be 0 thru 7. To compute the correct attribute, use the following formula: ATTRIBUTE = Foreground + (16 * Background) For a blinking foreground, add 128 to the attribute. This sounds a lot more complicated than it actually is. To help you, we have included a Script called COLORS.SCR on the Utilities Disk. Run this script to view all available color combinations and values. See also ATWRITE Example COLOR 30 ;Yellow on Blue COLOR 2 ;Green on Black COLOR 207 ;Blinking White on Red ______________________________________________________________________ COLORBG ______________________________________________________________________ Function Changes just the background color of displayed text. Declaration COLORBG ATTRIBUTE Version 4.0 217 Remarks This command sets the background color with a single attribute. ATTRIBUTE is an explicit numeric value or variable. The following are valid ATTRIBUTE values: 0 Black 1 Blue 2 Green 3 Cyan 4 Red 5 Magenta 6 Brown 7 Light Gray See also ATWRITE, COLOR, COLORFG Example COLORBG 1 ;Changes the background to Blue ______________________________________________________________________ COLORFG ______________________________________________________________________ Function Changes just the foreground color of displayed text. Declaration COLORFG ATTRIBUTE Remarks This command sets the foreground color with a single attribute. ATTRIBUTE is an explicit numeric value or variable. The following values are valid color attributes: 0 Black 8 Dark Gray 1 Blue 9 Light Blue 2 Green 10 Light Green 3 Cyan 11 Light Cyan 4 Red 12 Light Red 5 Magenta 13 Light Magenta 6 Brown 14 Yellow 7 Light Gray 15 White For a blinking foreground, add 16 to the attribute. See also ATWRITE, COLOR, COLORBG Example COLORFG 7 ;change the foreground to white 218 Scripts Operation Manual ______________________________________________________________________ DEBUG ______________________________________________________________________ Function Enable or disable the Internal Script Debugger. Declaration DEBUG ON|OFF Remarks The DEBUG command is useful in developing complex scripts since you can trace script execution on-screen and in real- time mode. DEBUG is OFF by default when a script starts. Example DEBUG ON ;Turn it on - - - execute script commands - - - DEBUG OFF ;Turn it back off ______________________________________________________________________ DECR ______________________________________________________________________ Function Decrement the value stored in a variable. Declaration DECR VARIABLE Remarks DECR decrements the value of a numeric variable by 1. If the variable is non- numeric or not greater than zero, an error will occur. See also INCR, STRING, ASSIGN Example ASSIGN 0 10 ;load $0 with 10 LOOP: ;a place to loop to DISPLAY "$0" ;display the value DECR 0 ;decrement $0 by 1 IF "$0" = "0" DONE ;if it is equal to 0 ;goto DONE GOTO LOOP ;Branch back to LOOP DONE: ;Exit point ______________________________________________________________________ DELAY ______________________________________________________________________ Function Pause a script for a certain amount of time. Declaration DELAY DELAYVALUE Version 4.0 219 Remarks DELAYVALUE is an explicit value or numeric variable containing the duration of the delay in milliseconds (1000 = 1 second). This is similar to the PAUSE command, but no characters are displayed during a DELAY. You might want to use this command when building menus or displaying online help. See also PAUSE Example DELAY 1000 ;stops for 1 second DELAY 10000 ;stops for 10 seconds DELAY 100 ;stops for 1 tenth of a second ______________________________________________________________________ DIAL ______________________________________________________________________ Function Used to tag and dial one or more entries. Declaration DIAL DIALSTRING Remarks The DIAL command is used to call one or more entries stored in the phone directory. DIALSTRING is a string or string variable in the same format as the Tag Multiple entry in the Alt-D directory display. Please refer to the Tag Multiple command under Alt-D for additional information. Example DIAL "1" ;dial entry number 1. DIAL "TForbin" ;dial all numbers that match ;the text "FORBIN". DIAL "PA1B PA2" ;dial 1 & 2 with Prefix ;modifiers. Restrictions If a script is linked to the entry being dialed, it will not be executed. All commands to be executed must be defined in the script file which contains the DIAL command. TIP: DIAL keeps dialing the same entry until a connection is established. To dial a number once without re-tries, use the SEND command with the appropriate modem dialing string. Example SEND "ATDT 1 319 233-6157^M" ;dial the number WAITFOR "CONNECT" ;wait for connect - - - ;more commands 220 Scripts Operation Manual TIP: If you sort the phone book and make explicit reference to entry numbers, be sure to reflect the changes in your script's DIAL commands. To dial an entry regardless of its number, use the Text Match tagging method. ______________________________________________________________________ DISPLAY ______________________________________________________________________ Function Display a line of text on the screen. Declaration DISPLAY TEXT Remarks The TEXTSTRING string or string variable is displayed at the current cursor position and in the current color. Following the DISPLAY, the cursor is located after the last character in TEXTSTRING. The text is not sent to the serial port. The cursor position is set by default following a DISPLAY, DISPLAYLN, NOTE or ATWRITE statement, or by the user with a GOTOXY statement. The color is the screen's default, or is set by the user with a COLOR statement. See also ATWRITE, COLOR, DISPLAYLN, GOTOXY, NOTE Example GETSCR ;save the screen BOX 1 1 20 9 ;draw a box COLOR 11 ;set color to Light Cyan GOTOXY 6 2 ;go to col 6, row 2 DISPLAY "TEST MENU" ;show heading COLOR 10 ;set Light Green color GOTOXY 3 4 DISPLAY "A) Option one" GOTOXY 3 5 DISPLAY "B) Option two" GOTOXY 3 6 DISPLAY "C) Option three" GOTOXY 3 7 DISPLAY "D) Option four" GOTOXY 3 7 DISPLAY "Option # ? " COLOR 15 ;set color to White GET 0 1 ;read character into $0 PUTSCR ;restore the screen Note: DISPLAY is similar to the basic statement PRINT "Text"; (note the semicolon) which does not automatically re- position the cursor to the next line and allows concatenation of displayed strings on the screen. Version 4.0 221 ______________________________________________________________________ DISPLAYLN ______________________________________________________________________ Function Display a line of text on the screen. Declaration DISPLAYLN TEXT Remarks The text defined by TEXT is displayed at the current cursor position and in the current color. Following the display, î:yúTHANKYOUDOCl·olumn of the next line in the logical screen. The text is not sent to the serial port. Original cursor location and color is described under the DISPLAY command. See also DISPLAY, ATWRITE Example GETSCR ;save the screen COLOR 11 ;set color to Light Cyan DISPLAYLN "TEST MENU" ;show heading COLOR 10 ;set Light Green color DISPLAYLN "A) Option one" DISPLAYLN "B) Option two" DISPLAYLN "C) Option three" DISPLAYLN "D) Option four" DISPLAY "Option # ? " COLOR 15 ;set color to White GET 0 1 ;read character into $0 PUTSCR ;restore the screen NOTE: DISPLAYLN is similar to the basic PRINT "Text" statement (note the lack of a trailing semicolon) which relocates the cursor to the beginning of the next line after printing. ______________________________________________________________________ DOS ______________________________________________________________________ Function Execute a DOS.command. Declaration DOS COMMAND Remarks DOS is the script equivalent of the Alt-R command; it invokes the Qmodem DOS Shell, and it is subjected to the same limitations. Please refer to the Alt-R command for additional information on the DOS Shell . COMMAND must be a word, string, or string variable. 222 Scripts Operation Manual Example DOS "Copy text.doc PRN" ;copy a doc file to ;the printer. DOS "123" ;run Lotus 123 DOS "type text.doc|more" ;even pipes and ;redirection work! DOS "COMMAND" ;will invoke the command prompt ;until EXIT is entered, just ;like Alt-R ______________________________________________________________________ DOWNLOAD ______________________________________________________________________ Function Receive a file. Declaration DOWNLOAD PROTOCOL FILENAME [ASCII options] Remarks DOWNLOAD is the script equivalent of the PgDn command. PROTOCOL must be one of the internal or external file transfer protocols defined to Qmodem. FILENAME must be fully qualified (include the drive and path) or it will be saved in the download directory (Alt-N/D/D). If the download directory is blank, then the file will be saved in the current directory. Status information is shown in a window while the transfer takes place. Internal Protocols: A ASCII X Xmodem C Xmodem CRC R Relaxed Xmodem O Xmodem-1K F Xmodem-1K/G Y Ymodem Batch G Ymodem/G Batch ASCII downloads can have optional parameters to aid in conversion from one system to another. They can be specified in any order and are not case sensitive. The parameters are: XLATE=[ON|OFF] Sets translate table usage. CR=[NONE|STRIP|ADDLF] Sets CR handling options. LF=[NONE|STRIP|ADDCR] Sets LF handling options. See also DOWNLD, UPLOAD, UPLD Version 4.0 223 Example DOWNLOAD Y C:\QMODEM\ ;Batch Ymodem download DOWNLOAD O THISFILE.TXT ;saves to current directory CHDIR C:\QMODEM ;change directory DOWNLD C QMODEM30.ARC ;put in current directory DOWNLOAD A Filename XLATE=on CR=addlf LF=strip ;This will filter the incoming data through the Input ;Translate Table, add one LF after each CR, and strip ;all LF's as it saves to FILENAME. CAUTION: When using the ASCII protocol, Qmodem must receive a ^Z (EOF) character or the download will never terminate. ______________________________________________________________________ DOWNLD ______________________________________________________________________ Function Receive a file (short form). Declaration DOWNLD PROTOCOL FILENAME [ASCII options] Remarks DOWNLD is the equivalent of the Ctrl-PgDn command; its syntax and function are identical to the DOWNLOAD script command. With DOWNLD, the status line is used instead of a window to monitor progress. Please refer to the DOWNLOAD and Ctrl-PgDn commands for additional information. See also DOWNLOAD, UPLOAD, UPLD ______________________________________________________________________ DRIVE ______________________________________________________________________ Function Change the default drive. Declaration DRIVE LETTER Remarks DRIVE changes the default logged drive, but does not switch directories as does the CHDIR command. LETTER is any valid drive letter in your system (A-Z), including those defined with the DOS SUBST command. DRIVE is the equivalent of the Alt-L command. See also CHDIR 224 Scripts Operation Manual Example DRIVE A ; switch to the A: floppy drive DRIVE C ; switch to the C: drive DRIVE Z ; switch to the Z: drive ______________________________________________________________________ EGA ______________________________________________________________________ Function Change screen size on systems equipped with EGA or VGA display adapters. Declaration EGA 25|43|50 Remarks EGA changes the number of screen lines to the new value specified in the command (43 and 50 are interchangeable to remain compatible with previous releases of Qmodem). If 43 or 50 is specified, EGA systems will switch to an 80x43 screen size, while VGA cards will switch to 80x50. EGA is the equivalent of the Alt-2 and Alt-4 commands. Restrictions This command is ignored if no EGA or VGA is present. Example EGA 43 ;switch to 80x43 (EGA) or 80x50 (VGA). EGA 25 ;switch to 80x25 for both EGA and VGA. NOTE: The screen will be cleared after each EGA command. ______________________________________________________________________ EXIST ______________________________________________________________________ Function Conditional branch depending on the presence of a file. Declaration EXIST FILENAME LABEL Remarks If FILENAME is found, the script will jump to the location in LABEL. If a wildcard filename is passed, at least one match will set the $SUCCESS flag and a jump to LABEL occurs. If there are no matches, the $FAIL flag is set and script execution will continue with the next sequential statement. Version 4.0 225 Example EXIST C:\AUTOEXEC.BAT YES ;if there is an autoexec.bat in the C:\ root ;directory, jump to label YES: - - - ;do other script commands if it does not exist. YES: ;label ASSIGN 0 C:\AUTOEXEC.BAT ;assign $0 the filename EXIST $0 YES ;same as above ______________________________________________________________________ EXIT ______________________________________________________________________ Function Terminates the script and returns to terminal mode. Declaration EXIT Remarks The script is unconditionally stopped, and control returns to Qmodem. See also RETURN Example EXIT ;stop the scripts NOTE text ;does NOT execute because of EXIT ______________________________________________________________________ FKEY ______________________________________________________________________ Function Execute an F-Key macro. Declaration FKEY KEYNO Remarks FKEY executes the command stored in the current function key file. The function key and shift state are defined by the explicit numeric value or variable KEYNO, based on the following table: 1 - 12 Normal F1 - F12 13 - 24 Shift F1 - F12 25 - 36 Ctrl F1 - F12 37 - 48 Alt F1 - F12 See also LOADKEY Example FKEY 27 ;send the string stored in Ctrl-F3. FKEY 1 ;send the string in F1. 226 Scripts Operation Manual TIP: FKEY will execute commands stored in function keys 11 and 12, even if your keyboard has only 10 function keys rather than 12. Refer to the Alt-J command for information on storing commands into function keys. ______________________________________________________________________ FLUSH ______________________________________________________________________ Function Clear the Keyboard buffer, COM port buffer, or both. Declaration FLUSH KBD|COM|ALL Remarks FLUSH clears data pending in the keyboard buffer (KBD option), the COM port buffer (COM option), or both (ALL). Any pending input data stored in the buffers is lost. Example DISPLAY "What is your name? " ;ask for a name FLUSH COM ;clear the com port GET 1 20 ;read it into $1 ______________________________________________________________________ GET ______________________________________________________________________ Function Read data from the keyboard and store it into a variable. Declaration GET KBDATA COUNT Remarks Input: KBD Output: Screen and COM port The GET command only accepts data from the local keyboard. The data is echoed to the screen AND to the COM port. KBDATA is any valid string variable; its name is not preceded with the "$" identifier. COUNT is an explicit numeric value or variable which defines the maximum number of characters in the input string. [ENTER] terminates the GET command. See also GETR, GETN, GETNR, GETX, INKEY Example DISPLAY "Enter number ?" ;prompt for number. GET 0 2 ;read 2 chars max. DISPLAYLN "You entered $0" ;show it again. Version 4.0 227 ______________________________________________________________________ GETR ______________________________________________________________________ Function Read from both the local keyboard and COM port and store it in a variable. Declaration GETR KBCOMDATA COUNT Remarks Input: KBD and COM port Output: Screen and COM port GETR is a superset of the GET command which also accepts data from the COM port. Data is displayed on the screen and echoed back to the COM port. Parameters and coding syntax are identical to the GET command. If online checking is enabled with the TURNON ONLINE command, GETR will check the modem for an ONLINE condition. If the connection is lost (IE., carrier drop), the variable will contain the string "_OFFLINE_", regardless of the value in COUNT. See also GET, GETN, GETNR, GETX, INKEY Example WRITE "Enter number ?" ;ask for number over COM port GETR 0 2 ;read 2 chars max WRITELN "You entered $0" ;show again on both screens TURNON ONLINE ;online checking active WRITE "Enter a number ? " ;prompt for a number GETR num 5 ;read the number - - - - - - - - - Carrier drops - - - ;the caller hung up... - - - - - - IF '$num' = '100' Label_100 ;if num=100, ; goto Label_100. IF '$num' = '_OFFLINE_' Cycle ;if caller hung up, ; goto Cycle. ______________________________________________________________________ GETN ______________________________________________________________________ Function Read from the local keyboard and store it in a variable. Declaration GETN KBDATA COUNT 228 Scripts Operation Manual Remarks Input: KBD Output: Screen The GETN command accepts data from the local keyboard. The characters are displayed on the local screen only. GETN is syntactically identical to GET. See also GET, GETR, GETNR, GETX, INKEY Example DISPLAY "Enter number ?" ;ask for number GETN 0 2 ;read 2 chars max DISPLAYLN "You entered $0" ;show again on local screen ______________________________________________________________________ GETNR ______________________________________________________________________ Function Read from both the local keyboard and COM port and store it in a variable. Declaration GETNR KBCOMDATA COUNT Remarks Input: KBD and COM port Output: Screen GETNR reads data from the local keyboard and from the COM port. The characters are displayed on the local screen only. Version 4.0 229 GETNR is syntactically identical to GETR, and the GETR online dependency and restrictions also apply to GETNR. See also GET, GETN, GETNR, GETX, INKEY Example WRITE "Enter number ?" ;ask for number GETNR 0 2 ;read 2 chars max WRITELN "Caller entered $0" ;show again on local screen TURNON ONLINE ;online checking active WRITE "Enter a number ? " ;prompt for a number GETNR num 5 ;read the number - - - - - - - - - Carrier drops - - - ;the caller hung up... - - - - - - IF '$num' = '100' Label_100 ;if num=100, ; goto Label_100. IF '$num' = '_OFFLINE_' Cycle ;if caller hung up, ; goto Cycle. ______________________________________________________________________ GETSCR ______________________________________________________________________ Function Save a copy of the current screen in memory. Declaration GETSCR Remarks GETSCR saves a snapshot of the current screen for later re- display with the PUTSCR command. Restrictions GETSCR may be nested up to three levels deep. A "nesting level" is defined as a corresponding pair of GETSCR/PUTSCR commands. Beyond the third nesting level, an error condition occurs. See also PUTSCR, CLRSCR Example GETSCR ;save screen level 1 - - - ;process GETSCR ;save screen level 2 - - - ;process CLRSCR ;clear the screen - - - ;do more script commands PUTSCR ;restore screen level 2 - - - ;process PUTSCR ;restore screen level 1 230 Scripts Operation Manual NOTE: The above example demonstrate 2-deep GETSCR/PUTSCR nesting. ______________________________________________________________________ GETX ______________________________________________________________________ Function Read data from both the local keyboard and the COM port and storing it in a variable. Declaration GETX KBCOMDATA COUNT CHARACTER Remarks Input: KBD and COM port Output: Screen and COM port GETX captures incoming keyboard and COM data and stores it into the KBCOMDATA variable. CHARACTER terminates the input in addition to [ENTER]. Unlike other GET commands which require a carriage return <CR> to indicate the end of the input, GETX his will terminate when one of the following conditions is met: CHARACTER is found in the input data, COUNT characters have been received, or [ENTER] has been received. If online checking is enabled with the TURNON ONLINE command, GETX will check the modem for an ONLINE condition. If the connection is lost (IE., carrier drop), the variable will contain the string "_OFFLINE_", regardless of the value in COUNT. See also GET, GETR, GETN, GETNR, INKEY Example ;Let's assume that you are logging into an information ;service. After logon, the service sends you a message ;that tells how many new messages there are to read. ;You want to capture just the number for later use in ;the script. The message is in the following form: ;"NEW MESSAGES (xxx)" where xxx is the number. WAITFOR "MESSAGES (" ;look for beginning of number GETX 0 4 ) ;grab up to 4 characters or ;until the ")" character. Version 4.0 231 ______________________________________________________________________ GOSUB ______________________________________________________________________ Function Call a subroutine at a specified LABEL. Declaration GOSUB LABEL Remarks GOSUB passes control to a routine identified by its LABEL. Upon completion, the routine must use a RETURN command, at which time script execution resumes with the statement immediately following the GOSUB. GOSUB/RETURN may be nested up to a maximum of 20 levels. Restrictions SCRIPT commands and GOSUB/RETURN share a single nesting process. Together, they may not exceed 20 nesting levels in any combination. See also GOTO, RETURN, EXIT Example GOSUB SUB1 ;call the SUB1 subroutine EXIT ;end the script SUB1: ;the subroutine SUB1 - - - ;script commands RETURN ;end of subroutine ;will branch back to the EXIT statement ______________________________________________________________________ GOTO ______________________________________________________________________ Function Unconditional branch to a LABEL in the script. Declaration GOTO LABEL Remarks GOTO passes control to the routine identified by LABEL. Control cannot be returned by the routine which was the target of the GOTO. See also GOSUB, RETURN, EXIT Example GOTO SUB1 ;jump to SUB1 BACKHERE: ; EXIT ;end the script SUB1: ;the subroutine SUB1 - - - ;script commands GOTO BACKHERE ;end of subroutine. go back up 232 Scripts Operation Manual ______________________________________________________________________ GOTOXY ______________________________________________________________________ Function Locate the cursor at a known screen position. Declaration GOTOXY COL ROW Remarks COL and ROW are explicit numeric values or variables and must contain valid logical screen coordinates. If coordinates are invalid, the cursor will not be re-positioned. See also BOX, WINDOW Example GOTOXY 1 1 ;homes the cursor GOTOXY 80 24 ;puts cursor in lower right corner WINDOW 1 1 80 14 ;set a new window dimension GOTOXY 40 20 ;FAILS, not inside the window ______________________________________________________________________ GRAPHICS ______________________________________________________________________ Function Change Terminal Emulation mode. Declaration GRAPHICS EMULATION Remarks GRAPHICS changes the terminal protocol to that specified in the EMULATION variable. It is the script equivalent of the Alt-G command. EMULATION must be one of the following: TTY No Emulation ANSI Internal ANSI driver (compatible with ANSI.SYS) VT100 DEC VT100 terminal (no VT52 support) NOTE: The screen will clear when executing this command. Example GRAPHICS TTY ;switch to TTY mode GRAPHICS VT100 ;switch to VT100 mode. ______________________________________________________________________ HANGUP ______________________________________________________________________ Function Return the modem on Hook (Terminate the current online session). Declaration HANGUP Version 4.0 233 Remarks HANGUP is the script equivalent of the Alt-H command. The modem hangup command is sent and the connection, if any, is terminated. Example WAITFOR "COMMAND" ;wait for the command prompt SEND "G^M" ;send the [G]oodbye command HANGUP ;disconnect ______________________________________________________________________ IF ______________________________________________________________________ Function Conditional branch based on the result of a test. Declaration IF STRING1 OPCODE STRING2 LABEL (type 1) IF CONDITION LABEL (type 2) Remarks Type 1: If the result of the test defined by OPCODE is true, the script will branch to the routine called LABEL. Valid OPCODEs are: OPCODE Test Performed = If string1 equals string2, goto label < If string1 less than string2, goto label > If string1 greater than string2, goto label <= If string1 less than or equal to string2, goto label >= If string1 greater than or equal string2, goto label <> If string1 not equal to string2, goto label If STRING1 and STRING2 contain numeric values, a numeric comparison is performed. If either is non-numeric, the two strings are compared based on their ASCII character values. Type 2: IF checks for a specific condition and branch to LABEL if true. Valid conditions are: $ONLINE ;if Online, goto label $OFFLINE ;if Offline, goto label $SUCCESS ;if last operation was successful, goto label $FAIL ;if last operation failed, goto label $ONLINE and $OFFLINE reflect the status of the carrier detect (CD) signal. The ONLINE/OFFLINE indicator is also displayed on the Qmodem status line. 234 Scripts Operation Manual The $SUCCESS and $FAIL indicators are set by the following commands: UPLOAD, UPLD, DOWNLOAD, DOWNLD, CHDIR, DRIVE and HANGUP. The state of $SUCCESS or $FAIL must be set by one of these commands before the indicators can be checked. Once set, the state remains the same until it is changed again by the completion of another eligible command. Referring to either variable before it is set yields unpredictable results. Examples IF '$0' = 'YES' Yes_Label ;if $0 = YES, goto (type 1) ; Yes_Label IF "$0" = "" Nul_Label ;if $0 is empty, goto ; Nul_Label (type 2) IF $ONLINE Skip_Dial ;go around dial if ONLINE DIAL "1" ;dial if offline. Skip_Dial: ;continue... S1: ;a label DOWNLOAD X TEST.DOC ;download a file IF $FAIL S1 ;if failed, go try again ______________________________________________________________________ INCR ______________________________________________________________________ Function Increment a numeric variable. Declaration INCR NUMVAR Remarks INCR adds 1 to the value of a numeric variable. If the value before the INCR command was 32767, the variable will be set to zero. Restrictions If NUMVAR contains non-numeric data, a script error will occur. See also DECR Example ASSIGN 0 0 ;load $0 with 0 LOOP: DISPLAY "$0" ;show it. INCR 0 ;now increment it. IF '$0' >= '10' DONE ;loop until done GOTO LOOP DONE: Version 4.0 235 ______________________________________________________________________ INKEY ______________________________________________________________________ Function Reads a single character from the keyboard or COM port. Declaration INKEY INDATA Remarks INKEY reads a single character from the COM port or keyboard (whichever is received first) and stores it into the INDATA variable. Any keystroke or COM data is valid and [ENTER] does not have to be pressed for the script to continue. This command is useful to select menu options, for example. See also GET, GETR, GETN, GETNR Example DISPLAYLN "MENU" DISPLAYLN " " DISPLAYLN " A) Call The Forbin BBS" DISPLAYLN " B) Call GEnie" DISPLAYLN " C) Call it a day" DISPLAYLN " " DISPLAY " ?" TOP: INKEY 0 ;Store result in $0 IF "$0" < "A" TOP ;Try again IF "$0" > "C" TOP ;if not a valid choice ;Now $0 is either A, B or C. ______________________________________________________________________ LOADFON ______________________________________________________________________ Function Load a new Phone Book into memory. Declaration LOADFON FONFILE Remarks LOADFON loads a new Qmodem phone book. It is the script equivalent of the Alt-D/L command. FONFILE should be a word, string, or variable containing a fully qualified DOS filename with the .FON extension. If the drive and path are omitted, the current directory is searched. Refer to the Alt-D command for additional information on Qmodem phone directories. Restrictions The FILENAME must end with the .FON extension or an error will occur. See also DIAL 236 Scripts Operation Manual Example LOADFON C:\QMODEM\PCP.FON ;load a new FON file LOADFON C:\QMODEM\QMODEM.FON ;reload the original ______________________________________________________________________ LOADKEY ______________________________________________________________________ Function Load a new Alt-J Macro KEY file. Declaration LOADKEY KEYFILE Remarks LOADKEY loads a new Function Key Macro definition file, making 48 new F-Key macros available to the script. KEYFILE should be a word, string, or string variable containing a fully qualified DOS filename with the .KEY extension. If the drive and path are omitted, the current directory is searched. Restrictions the FILENAME must end in a .KEY extension or an error occurs. See also FKEY Example FKEY 1 ;send out the current F1 macro LOADKEY NEW.KEY ;load a new KEY file FKEY 1 ;send out a different F1 macro LOADKEY C:\QMODEM\1.KEY ;load still another KEY file ______________________________________________________________________ LOG ______________________________________________________________________ Function Open a LOG file to track Qmodem activity. Declaration LOG LOGFILE Remarks LOG opens a Qmodem Log file to which activity is recorded. LOG is the script equivalent of the Alt-0 command. Please refer to the Alt-0 documentation for further information on the Qmodem Log file feature. LOGFILE is a word, string, or string variable containing any valid DOS filename. If the file exists, data will be added to it. If the file does not exist, the script will create it. To disable the Logging feature in a script, use the TURNOFF LOG command. Version 4.0 237 See also STAMP, TURNOFF Example LOG PHONELOG.DAT ;start logging to file Phonelog.Dat - - - ;more scripts commands, some of ;which will be logged TURNOFF LOG ;close the log file ______________________________________________________________________ NOTE ______________________________________________________________________ Function Display a message on the screen and log it in the Capture file if open. Declaration NOTE TEXT Remarks NOTE displays the TEXT string on the screen. If Session Capture is active, TEXT is also recorded in the capture file. If the cursor is not in column 1, then a CR/LF precedes the TEXT to be displayed, forcing the cursor to the first position of the next line. Unlike other text display commands, the TEXT string is NOT bound by quotes. The string starts immediately after the first space following the NOTE command and ends with the last character on the line (or the semicolon which starts a comment field). See also CAPTURE, DISPLAY, DISPLAYLN Example NOTE This is a test of the note command ;comment1 ______________________________________________________________________ OPENFILE ______________________________________________________________________ Function Open a sequential TEXT file for input or output. Declaration OPENFILE FILENAME READ|REWRITE|APPEND Remarks OPENFILE opens a standard ASCII text file for input or output. FILENAME must be a valid DOS filename. Only one file may be open at a time. Parameters: READ Opens the file for INPUT with the READFILE command. 238 Scripts Operation Manual REWRITE Opens the file for OUTPUT with the WRITEFILE command. If the file exists, its contents are erased and its length is reset to zero. If the file does not exist, it is created. APPEND Opens the file for OUTPUT and positions the file pointer to the end of the file. All data written will be added sequentially at the end of the file. Restrictions Only one file can be open at a time. See also CLOSEFILE, READFILE, WRITEFILE Example CLRSCR NOTE Testing FILE I/O NOTE Clearing the file OPENFILE testfile rewrite ;open the file ASSIGN 1 0 ;set $1 = "0" NOTE Writing to the file T: WRITEFILE $1 ;write $1 to the file IF "$1" = "100" cl ;is $1 = 100? jump to CL: DISPLAY "$1 " ;display the counter INCR 1 ;increment $1 GOTO t ;loop and write again CL: CLOSEFILE ;close the file OPENFILE testfile read ;re-open for Reading NOTE Reading from the file READING: READFILE 0 ;read first line into $0 DISPLAY "$0, " ;show it IF "$0" = "_EOF_" done ;Is it EOF? goto DONE GOTO READING ;loop and read another DONE: CLOSEFILE ;close the file and EXIT ;exit ______________________________________________________________________ PAUSE ______________________________________________________________________ Function Pause a script for a specified amount of time. Declaration PAUSE PAUSEVAL Version 4.0 239 Remarks PAUSE is similar to DELAY, but normal screen and keyboard I/O are not suspended. PAUSEVAL is an explicit numeric value or variable containing the length of the delay in milliseconds (1000 = 1 second). This command is useful when building menus or displaying online help. Restrictions PAUSEVAL must be in the range 1-32767. See also DELAY Example PAUSE 100 ;stops for 1 tenth of a second PAUSE 1000 ;stops for 1 second PAUSE 10000 ;stops for 10 seconds ______________________________________________________________________ POP ______________________________________________________________________ Function Remove the top entry from the stack and store it in a variable. Declaration POP VARIABLE Remarks POP is used to retrieve a value which was PUSHed onto the "stack". The stack is an area of memory which can store up to 60 values (IE, text, number, etc...). The stack operates in LIFO mode (Last-In, First-Out). Thus, a POP command retrieves the item which was last PUSHed onto the stack. Retrieving a value other than the top one requires multiple POP commands. POPping an empty stack returns a NULL string (zero length). PUSHing a full stack yields a script error. See also PUSH 240 Scripts Operation Manual Example POP 0 ;POP stack into $0. $0 will be NULL ;because of no previous PUSH ASSIGN 0 0 ;set $0 to zero TOP: ;set a label TOP INCR 0 ;increment $0 NOTE This is $$0 [$0] ;display the value of $0 PUSH $0 ;PUSH it on the stack IF "$0" = "10" POPSTACK ;test for value of 10 GOTO TOP ;loop back POPSTACK: ;10 numbers on stack now POP 1 ;POP the stack into $1 NOTE This is $$1 [$1] ;display the value of $1 IF "$1" <> "" POPSTACK ;If not NULL, get another NOTE Done. ;now we're done EXIT ______________________________________________________________________ PORT ______________________________________________________________________ Function Switch to a different COM port. Declaration PORT PORTNUM Remarks PORT switches the active COM port. PORTNUM ia an explicit numeric value or variable in the range 1-8. If the port selected is valid, the current port is closed, DTR is dropped, the new port is opened with the same COM parameters as the old port and DTR is raised. PORT is the script equivalent of the Alt-K command. This command can be used to detect the active COM port (the port to which the modem is connected). Restrictions Valid COM ports must be defined in Setup (Alt-N/M/P). Version 4.0 241 Example ; ; This assumes a Hayes or compatible modem ; TIMEOUT 2 TRY2 ; PORT 1 ; select COM1 first SEND "AT^M" ; send the ATtention command WAITFOR "OK" ; look for the response GOTO ON-LINE! ; if successful, jump! TRY2: ; next label TIMEOUT 2 ERROR PORT 2 ; select COM2 SEND "AT^M" ; send the ATtention command WAITFOR "OK" ; look for the response GOTO ON-LINE! ; if successful, jump! ERROR: ; modem not found NOTE No Modem EXIT ON-LINE!: ; we found the modem so lets ; do something! ______________________________________________________________________ PUSH ______________________________________________________________________ Function Place an item on the top of the stack. Declaration PUSH TEXT Remarks PUSH stores an INTEGER, WORD, STRING or VARIABLE onto the top of the stack. TEXT can be retrieved later with the POP command. Please refer to the POP command for additional details, restrictions, and code example. See also POP Example See the POP command. ______________________________________________________________________ PUTSCR ______________________________________________________________________ Function Restores a screen previously saved with GETSCR. Declaration PUTSCR Remarks PUTSCR works in conjunction with the GETSCR command, in a manner very similar to the PUSH and POP command pair. 242 Scripts Operation Manual PUTSCR restores the screen which was saved by the GETSCR command at the same nesting level. The entire physical screen is restored, as opposed to the logical screen defined with a BOX or WINDOW command. Restrictions Results are unpredictable if a previous GETSCR has not been executed prior to the PUTSCR command. GETSCR/PUTSCR may be nested up to three levels. See also GETSCR Example GETSCR ;save the current screen CLRSCR ;clear the screen - - - ;do more script commands PUTSCR ;restore the previously saved screen ______________________________________________________________________ READFILE ______________________________________________________________________ Function Read a record from a text file. Declaration READFILE INDATA Remarks READFILE command reads one line of text from the file opened with the OPENFILE command and stores it into the INDATA variable. See the OPENFILE command for an explanation and example. Restrictions The Text file must have been opened with the READ option or a script error occurs. See also CLOSEFILE, OPENFILE, WRITEFILE ______________________________________________________________________ RETURN ______________________________________________________________________ Function Return from a GOSUB or SCRIPT command. Declaration RETURN Remarks RETURN returns control to the statement which immediately follows the GOSUB or SCRIPT command through which the routine received control. If there was no previous GOSUB or SCRIPT, RETURN behaves like an EXIT command. To unconditionally terminate a script, always use the EXIT command. Version 4.0 243 See also GOSUB, SCRIPT Example GOSUB SUB1 ;call the SUB1 subroutine EXIT ;end the script SUB1: ;the subroutine SUB1 - - - ;script commands RETURN ;end of subroutine ;will branch back to the EXIT statement ______________________________________________________________________ SCRIPT ______________________________________________________________________ Function Call another script as a subroutine. Declaration SCRIPT SCRFILE Remarks SCRIPT passes control to the script identified in SCRFILE and operates identically to the GOSUB command. If the script being called includes a RETURN command, execution of the calling script will resume with the statement following the SCRIPT command. SCRFILE should be the name of a script file stored in the directory specified in Setup (Alt-N/D/S). Restrictions Up to 40 levels of SCRIPT and GOSUB commands may be nested. See also GOSUB, RETURN Example ; .....Script ONE.SCR..... ;a comment line NOTE Executing Script ONE.SCR ;display a note SCRIPT TWO.SCR ;call another script NOTE Back in ONE.SCR ;display a note SCRIPT THREE.SCR ;call another script NOTE Back in ONE.SCR ;display a note EXIT ;halt execution ; .....Script TWO.SCR..... ;comment line NOTE Executing Script TWO.SCR SCRIPT THREE.SCR ;call another script NOTE Back in TWO.SCR RETURN ;return to previous script ; .....Script THREE.SCR..... ;comment line NOTE Executing Script THREE.SCR RETURN ;return to previous script 244 Scripts Operation Manual The output of these three scripts (provided ONE.SCR was executed first) will be: Executing Script ONE.SCR Executing Script TWO.SCR Executing Script THREE.SCR Back in TWO.SCR Back in ONE.SCR Executing Script THREE.SCR Back in ONE.SCR ______________________________________________________________________ SEND ______________________________________________________________________ Function Send data to the COM port. Declaration SEND STRING Remarks The text specified by STRING is sent to the COM port and displayed on the local screen. The cursor will be positioned after the last character in STRING. Example SEND "^M" ;send a carriage return ([ENTER]) SEND "^~^~ ^~ ^~ ^M" ;pause one second followed by ;3 spaces at .5 second each and ;then [ENTER] ASSIGN 0 "^~^~ ^~ ^~ ^M" ;put the above string in $0 SEND $0 ;send it SEND "$Password^M" ;send Password stored in the ;dialing directory only after a ;valid connect. ______________________________________________________________________ SETCOMM ______________________________________________________________________ Function Change the current COM port settings. Declaration SETCOMM PARAMETER [PARAMETER..] Remarks SETCOMM is the script equivalent of the Alt-P command. At least one parameter is required; parameters may be specified in any order. If two conflicting parameters are entered (IE, SETCOMM AB), the last parameter takes precedence. Version 4.0 245 Valid parameters are: A|300 300 baud B|1200 1200 baud C|2400 2400 baud D|4800 4800 baud E|9600 9600 baud F|19200 19200 baud G|38400 38400 baud H|EVEN Even parity I|ODD Odd parity J|NONE No parity K|7 7 data bits L|8 8 data bits M|1 1 stop bit N|2 2 stop bits Example SETCOMM CJLM ;sets 2400-N-8-1 SETCOMM 9600 ;change only the baud rate to 9600 ______________________________________________________________________ STAMP ______________________________________________________________________ Function Write a string to the LOG file. Declaration STAMP TEXT Remarks STAMP is similar to NOTE, but the TEXT string is not displayed on the screen. TEXT is stored into the LOG file (if open). Any text following the STAMP keyword is "logged". See also NOTE Example NAME_LABEL: WRITELN " [-------26-chars-max-------]" WRITE "Enter your name ? " GETR NAME 26 IF "$NAME" = "" NAME_LABEL ;check for null IF "$NAME" = "_OFFLINE_" CYCLE ;check offline STAMP **************************** STAMP User [$NAME] Logged On could add the following two lines to the LOG file: 10:37:33 04/10/87 STAMP **************************** 10:37:33 04/10/87 STAMP User [Sysop] Logged On 246 Scripts Operation Manual ______________________________________________________________________ STRING ______________________________________________________________________ Function Define one or more variable(s) Declaration STRING VARIABLE [VARIABLE...] Remarks Up to 60 variables can be defined with the STRING command. New variables are referenced by prefixing them with "$" (except where noted). Restrictions Variables are stored in the order in which they were defined. All user-defined variable names must start with a letter. If two or more variable names share the same beginning characters, define the longest name first. Otherwise, only the shortest name will be recognized. For example, let's define three new variables called $A, $AA and $AAA. To be able to reference all three, they must be defined as follows: STRING AAA, AA, A See also ASSIGN Example STRING THIS THAT OTHER ;create three variables ASSIGN THIS "NEW TEST" ;put "NEW TEST" in $THIS NOTE [$THIS] [$THAT] [$OTHER] ;display their values would display: [NEW TEST] [] [] ______________________________________________________________________ SYSTEM ______________________________________________________________________ Function Stop the script and exit Qmodem. Declaration SYSTEM X|Y Remarks SYSTEM unconditionally halts script execution and exits Qmodem. It is the script equivalent of the Alt-X command. See also EXIT, RETURN Version 4.0 247 Example SYSTEM X ;exit Qmodem with DTR left High SYSTEM Y ;exit Qmodem with DTR dropped ______________________________________________________________________ TIMEOUT ______________________________________________________________________ Function Set a WAITFOR timeout value and optional routine label. Declaration TIMEOUT TIMEVAL [LABEL] Remarks TIMEOUT controls the length of time WAITFOR commands will wait for a text string. TIMEVAL is an explicit value or numeric variable containing the timeout delay (in seconds). If LABEL is specified, the script will branch to that routine when the timeout delay expires. If LABEL is omitted, the script will terminate with a timeout error. See also WAITFOR Example TIMEOUT 3 AGAIN ;set timer to 3 seconds, label AGAIN AGAIN: ;here's the label SEND "ATZ^M" ;send modem reset command WAITFOR "OK" ;if OK is not seen in 3 seconds, ; goto the label AGAIN (try again) ______________________________________________________________________ TURNOFF TURNON ______________________________________________________________________ Function Change Qmodem operating parameters. Declaration TURNOFF KEYWORD [KEYWORD...] TURNON KEYWORD [KEYWORD...] Remarks TURNON and TURNOFF are ON/OFF switches for Qmodem functions or facilities which can affect the operation of Qmodem, even after the script has terminated. Following is the list of valid TURNON/TURNOFF keywords and the equivalent terminal mode command. The third and fourth columns indicate whether the keyword can be used with TURNOFF and TURNON. The fifth column provides a brief description of the keyword. 248 Scripts Operation Manual Keyword Cmd OFF ON Action ------- ------ --- -- ----------------------------------- 8_BIT Alt-8 x x 8 bit mode BS_DEL Alt-1 x x Mode of the Backspace key, On: BS=DEL Off: BS=^H CAPTURE ^Home x Off only. Closes Capture file if open CASE x x Case sensitivity of WHEN and WAITFOR ECHO Alt-E x x Local Echo mode (duplex) LINEFEED ShftTab x x Controls adding LF's to incoming CR's LOG Alt-0 x Off only. Closes the LOG file if open MUSIC Alt-M x x ANSI Music mode NOISE Alt-B x x Beeps & Bells (on or off) ONLINE x x State of carrier detection for the GET Script commands PRINT ^PrtSc x x Local print echo mode SCROLL Alt-U x x Scroll-back capture mode SPLIT Alt-S x x Split screen mode on or off XON/XOFF Alt-Z x x XON/XOFF flow control mode Example TURNON 8_BIT NOISE XON/XOFF TURNOFF MUSIC ECHO LINEFEED CAPTURE C:\QMODEM\CAP.TXT ;turn on the capture file TURNOFF CAPTURE ;close the capture file TURNOFF LOG ;nothing happens, not open ______________________________________________________________________ UPLOAD ______________________________________________________________________ Function Send a file to the other computer. Declaration UPLOAD PROTOCOL FILENAME [ASCII OPTION...] Remarks UPLOAD performs two basic types of file transfers; ASCII and non-ASCII. FILENAME must be a fully qualified DOS filename, or the file must be located in the current directory. Valid protocols are: A ASCII X Xmodem C Xmodem CRC R Relaxed Xmodem O Xmodem-1K F Xmodem-1K/G Y Ymodem Batch G Ymodem/G Batch Version 4.0 249 All external protocols (defined with Alt-N/P) are also valid. For ASCII uploads, additional parameters may be specified to override the Setup (Alt-N/P/A/T) defaults. Following are the valid ASCII upload options: PACECH=[NONE|character] Specifies a "pacing character" which must be received before the next ASCII record (IE,, text line) is sent. The first line of the file is always sent regardless of this setting. PACESPEED=[nnnn] The delay, in milliseconds (1000 = 1 second) inserted between each character sent. XLATE=[ON/OFF] Specifies whether the outgoing file is (ON) or is not (OFF) to be translated with the output translate table (Alt-A-2) prior to being sent. CR=[NONE/STRIP/ADDLF] Defines carriage-return (CR) handling. This is normally not needed unless the receiving computer does not recognize the standard CR character (ASCII 13). LF=[NONE/STRIP/ADDCR] Defines LineFeed (LF) handling. Similar to CR, but affects the LF character (ASCII 10). EXPAND=[ON/OFF] If ON, adds a leading space to null lines (which contain only a CR/LF pair) so that there is a leading SPACE. This is a useful feature when uploading messages to most BBS systems, which interpret a null line as and end-of-message indication. EOLCH=[nnn] Defines the ASCII value of the End-Of-Line character. It is very important to set this parameter correctly. Since most ASCII files end each line with a CR/LF sequence, the LF character should be defined as the EOLCH (LF is ASCII 10). See also UPLD, DOWNLOAD, DNLD 250 Scripts Operation Manual Example UPLOAD O QMODEM.ARC ;send the file QMODEM.ARC using non-ASCII ;Xmodem-1K. The file must be in ;the current directory UPLOAD X C:\AUTOEXEC.BAT ;upload the autoexec.bat file ;from the C: root directory ;using Xmodem Example SEND "^M" ;send a carriage return ASCII WAITFOR "Command" ;look for the command line SEND "E^M" ;command to enter a message WAITFOR "To [Enter]=all?" SEND "Sysop^M" ;to the Sysop WAITFOR "Subject:?" SEND "A Private msg^M" ;the msg description WAITFOR "Security:" SEND "R^M" ;Receiver only UPLOAD A TEST.DOC PACECH=: EXPAND=ON EOLCH=10 ;upload a text file to a PCB BBS ; and use the colon as the pace char SEND "^M^~^~S^M" ;tell the board to save the msg ______________________________________________________________________ UPLD ______________________________________________________________________ Function Send a file to the other computer (short form). Declaration UPLD PROTOCOL FILENAME [ASCII OPTION...] Remarks UPLD is functionally identical to UPLOAD. Rather than a status window, UPLD displays transfer information on the status line. Please refer to the UPLOAD command for complete information. ______________________________________________________________________ WAITFOR ______________________________________________________________________ Function Wait for a specific string to be received. Declaration WAITFOR STRING Version 4.0 251 Remarks WAITFOR waits for the defined text string to be received on the COM port. WAITFOR will wait the amount of time specified in the last TIMEOUT command. If no TIMEOUT command was issued, a default of 60 seconds is used. Each WAITFOR command may have a corresponding TIMEOUT value for explicit control of timing and error conditions. If this method is selected, all WAITFOR commands should have an associated TIMEOUT command This will minimize unexpected errors (such as an incorrect branch). See also TIMEOUT Example TIMEOUT 3 AGAIN ;set timer to 3 seconds, label AGAIN AGAIN: ;here's the label SEND "ATZ^M" ;send modem reset command WAITFOR "OK" ;if OK is not seen in 3 seconds, ; goto the label AGAIN (try again) ______________________________________________________________________ WAITUNTIL ______________________________________________________________________ Function Wait for a specified time before continuing. Declaration WAITUNTIL TIME Remarks WAITUNTIL suspends script execution until a specific time of day. TIME must be in 24-hour clock format (HH:MM:SS) with 00:00:00 being midnight. WAITUNTIL is the script's alarm clock. While WAITUNTIL is in effect, the target TIME and the current system time are displayed side by side until they match, at which time the script resumes execution with the next command. See also DELAY, PAUSE Example WAITUNTIL 04:00:00 ;wait till 4 a.m. DIAL "1 2 3 4" ;dial the numbers WAITUNTIL 24:00:00 ;will never get past this, because ;24hr time does not have 24:00:00 252 Scripts Operation Manual ______________________________________________________________________ WHEN ______________________________________________________________________ Function Allows searching for alternate text strings while WAITFOR is active. Declaration WHEN STRING1 STRING2 (type 1) WHEN STRING1 LABEL (type 2) WHEN (type 3) Remarks WHEN may only be used while a WAITFOR is active. WHEN (Type 1) sends STRING2 when STRING1 is received WHEN (Type 2) branches to LABEL when STRING1 is received. WHEN (Type 3) immediately cancels all active WHEN commands. WHEN can be used in a logon (linked) script for systems which change certain prompts depending on when you last called. PCBoard, for example, changes prompts if you call more than once during the same day. A maximum of 10 WHEN statements can be active at one time. WHEN statements remain active until they are explicitly canceled by a blank WHEN, and are not subjected to the TIMEOUT restrictions which affect WAITFOR commands. See also WAITFOR Example WHEN WHEN "Press (Enter) to continue?" "^M" WHEN "MUSIC? (Enter)=no?" "N Q^M" WHEN "What is your first name?" "John Friel PS^M" WHEN "MAILBOX for your mail?" "N^M" WHEN "Conference members (Enter)=no?" "N^M" WHEN "More (Y), (N), (NS)" "N^M" WHEN "Enter Language #" "^M" WHEN "(H)elp, More?" "N^M" WHEN "ENTER to continue" "N^M" WAITFOR "Main Board Command?" DELAY 100 WHEN The first WHEN (Type 3) clears any pending WHEN commands. The following WHEN (Type 1) commands identify all logon prompts and their respective responses. With this method, only one WAITFOR is needed; WHEN commands handle all others prompts. Version 4.0 253 ______________________________________________________________________ WINDOW ______________________________________________________________________ Function Create a logical screen with user defined dimensions. Declaration WINDOW C1 R1 C2 R2 Remarks WINDOW creates a logical screen window. Unlike the BOX command, WINDOW does not cause a frame to be drawn on the screen. For additional information, please refer to the BOX command. Restrictions See the BOX command. See also BOX, CLRSCR, GETSCR, PUTSCR Example WINDOW 1 1 80 24 ;window the full size of the screen WINDOW 20 4 60 8 ;window 40 cols wide by 4 lines high ______________________________________________________________________ WRITE ______________________________________________________________________ Function Send text to the COM port without a CR/LF. Declaration WRITE STRING Remarks WRITE sends text data to the COM port, but does not add a CR/LF at the end of the string. This is useful when sending prompts to insure that the cursor remains on the same line. The WRITELN command is similar, but adds a CR/LF at the end of the string. See also WRITELN, DISPLAY, DISPLAYLN, SEND Example WRITELN " [------------]" WRITE "Enter your first name ? " GETR F_NAME 12 WRITELN " " WRITELN " [--------------------]" WRITE "Enter your last name ? " GETR L_NAME 20 WRITELN " " WRITELN " [------------]" WRITE "Enter your password ? " GETR P_WORD 12 254 Scripts Operation Manual The following will be displayed on the receiving computer: [------------] Enter your first name ? JOHN [--------------------] Enter your last name ? FRIEL III [------------] Enter your password ? PASSWORD ______________________________________________________________________ WRITELN ______________________________________________________________________ Function Send text out the COM port with a CR/LF. Declaration WRITELN STRING Remarks WRITELN is the CR/LF version of the WRITE command. See also WRITE, DISPLAY, DISPLAYLN, SEND Example WRITELN " [------------]" WRITE "Enter your first name ? " GETR F_NAME 12 WRITELN " " WRITELN " [--------------------]" WRITE "Enter your last name ? " GETR L_NAME 20 WRITELN " " WRITELN " [------------]" WRITE "Enter your password ? " GETR P_WORD 12 The following will be displayed on the receiving computer: [------------] Enter your first name ? JOHN [--------------------] Enter your last name ? FRIEL III [------------] Enter your password ? PASSWORD Version 4.0 255 ______________________________________________________________________ WRITEFILE ______________________________________________________________________ Function Write a line to a text file. Declaration WRITEFILE WORD|STRING|VARIABLE Remarks WRITEFILE writes a word, string, or string variable to the file opened by the OPENFILE command. Restrictions OPENFILE with the REWRITE or APPEND option must have been issued first. See also CLOSEFILE, OPENFILE, READFILE Example See the OPENFILE command for an explanation and example. 256 Scripts Operation Manual Error Messages ______________________________________________________________________ CAPTURE Filename not found The CAPTURE command expected a WORD parameter and it was either missing or a STRING was specified. DOWNLOAD Filename expected The command was not followed by any text or the following text was not a WORD. DRIVE Letter A..Z expected The DRIVE command did not receive a character between A and Z as a parameter. EGA value must be 25, 43 or 50 The value passed to the EGA command was not 24, 43 or 50. Use a correct value. ERROR opening FILE An error occurred in OPENFILE Check the filename and correct. ERROR Opening Script File The script file was found, but could not be opened. Make sure the file is not locked in a network environment. ERROR reading from FILE An error occurred in a READFILE command. Make sure that the file contains valid data. ERROR writing to FILE An error occurred in a WRITEFILE command. Make sure the file is not locked by a network or multi-tasker, and that you are not running out of disk space, and try again. Version 4.0 257 File already open Two OPENFILE commands were issued without an intervening CLOSEFILE. Only one file may be opened at a time. FILE not open READFILE or WRITEFILE was issued before the file was opened with OPENFILE. Check the script logic. FILE not open for READ READFILE was issued against a file opened for REWRITE or APPEND. The file must be opened for READ. FILE not open for WRITE/APPEND WRITEFILE was issued against a file opened for READ. The file must be opened for WRITE or APPEND. FKEY Filename does not exist The filename specified in the LOADKEY command does not exist. FLUSH keyword not KBD, COM or ALL The FLUSH command requires the keyword KBD, COM or ALL. Correct and re-try. FON Filename does not exist The filename specified in the LOADFON command does not exist. GETSCR Nested too deep GETSCR/PUTSCR commands can be nested 3-deep. A 4th GETSCR was detected without a corresponding PUTSCR. 258 Scripts Operation Manual GRAPHICS Keyword not found GRAPHICS was issued without a parameter or with an invalid one. Correct and re-try. Insufficient space for String STRING memory (defined in Alt-N/O/M/S) is exhausted. Increase the memory allocation, exit and restart Qmodem, and re-run the script. INTEGER expected The command expected an INTEGER value (-32768 to 32767). The variable or string was null or contained non-integer data. INTEGER value required for INCR or DECR The VARIABLE argument in an INCR or DECR command did not contain an integer value. Check script logic and ASSIGN commands and insure that numeric data is stored into the variable. Invalid IF Opcode The IF command requires one of 6 comparison Opcodes. Make sure the Opcode is correct and that necessary quotes are used. Invalid KEYWORD or TOKEN The first word in the line was not a valid KEYWORD, or the KEYWORD was passed the wrong type of data. Invalid LABEL or misplaced Colon A colon ":" was found at the beginning of a line. This may be an invalid LABEL or the colon needs to be changed to a semicolon if the line contains a comment. INVALID OPENFILE mode An invalid parameter followed the OPENFILE command. Valid OPENFILE parameters are READ, REWRITE, or APPEND. Version 4.0 259 Invalid Substitute VARIABLE The specified VARIABLE name was not found. Make sure the variable is defined with a STRING command before using it. Invalid UPLOAD keyword or keyword option One of the ASCII UPLOAD keywords was misspelled or contains an invalid parameter. Correct the keyword(s) and parameters and re- try. LABEL not found A LABEL was not found. Check the script for a possible omission or misspelling and try again. Line too long A script line exceeds 254 character. Edit the Script and make sure lines are less than 254 characters. LOADFON Filename not found LOADFON expected a WORD parameter. The parameter was missing or a STRING was specified instead. LOADKEY Filename not found LOADKEY expected a WORD parameter. The parameter was missing or a STRING was specified instead. LOG Filename not found The LOG command expected a WORD parameter and it was either missing or a STRING was specified. Off Screen Coordinates The Row and/or Column argument(s) of a GOTOXY command was (were) invalid. Since GOTOXY is limited by BOX/WINDOW boundaries, make sure you reset any WINDOW or BOX commands before assuming a full 80x25 screen. 260 Scripts Operation Manual ON or OFF parameter expected The DEBUG command can only be followed by the WORD ON or OFF. Correct and re-try. PORT selection invalid PORT expects a WORD in the range 1 to 8. It was either missing out of range. RETURN SCRIPT Filename not found A Calling script was not found when a RETURN command was issued (IE, it was deleted or renamed). Execution cannot continue. Check to be sure you are not deleting/renaming the calling script by accident. SCRIPT Filename not found A called SCRIPT file was not found. THE script filename parameter was missing, or the file could not be located. SCRIPT/GOSUB nested too deep SCRIPT and/or GOSUB commands were nested more than 40 levels. Some serious thought needs to be put into the script(s) to reduce the levels of nesting. SETCOMM Keyword or Letter expected An invalid parameter was used in a SETCOMM command. STRING expected A command required a STRING, but it was either missing or a WORD was specified. STRING length 0 A null string was used. The string must be at least 1 character. Version 4.0 261 STRING not defined The string variable used in a command was not defined. Define the variable with the STRING command and try again. STRING VARIABLE expected A string variable command parameter was missing, misspelled, or not defined. Substitute Line too long String variable substitution yielded a line longer than 254 characters. Use additional WRITE/DISPLAY/SEND commands to break up the line into shorter ones. SYSTEM parameter not "Y" or "X" "X" or "Y" are the only valid arguments of the SYSTEM command. Correct and try again. Target LABEL cannot be a KEYWORD A reserved script keyword was used as a label. Correct and try again. Too many PUSHes More than 40 values were PUSHed onto the stack without any intervening POPs. Too many WHEN's defined The maximum of 10 WHEN commands were active and an additional WHEN was issued. Use a blank WHEN command to clear unused WHENs and try again. TURNOFF Keywords(s) not found A TURNOFF keyword was missing or invalid. 262 Scripts Operation Manual TURNON Keyword(s) not found A TURNON keyword was missing or invalid. UPLOAD Filename does not Exist The UPLOAD filename did not exist. Verify the filename and try again. UPLOAD Filename expected The FILENAME argument of the UPLOAD command was not a WORD or was missing. WORD expected A WORD argument was expected, but it was missing or a STRING was used. WORD or LABEL expected A WORD or LABEL argument was expected, but it was missing or a STRING was used. WORD or STRING expected A WORD or string argument was expected, but was not found. This is usually caused by a missing parameter. Version 4.0 263 Appendix A - Most asked Questions or problems and their solutions ______________________________________________________________________ Question: When I start up Qmodem, the Online/Offline indicator in the status line always says ONLINE? Why? Answer: The modem is sending a signal back to Qmodem saying that it is connected to another computer. On Hayes modems and clones that use the '&' (ampersand) extended commands, there is usually a command that controls the CD (carrier detect) signal. The default mode (unfortunately) is for the CD to be on all the time. This makes Qmodem think it is ONLINE. To make things right, send the following command to your modem from Qmodem's terminal mode: AT&C1<enter> You will have to check your modem manual to verify this command in case it is not quite 100% Hayes compatible. Modems this is known to cure: Hayes 2400 (all models) Hayes V-Series (all models) Practical Peripherals (all models) Anchor Automation Patriot 2400i Some modems, as in the case of the Courier HST from USRobotics has a switch which by default has Carrier forced true. Switch number 6 is DOWN from the factory and must be set to UP to work correctly. Running the HST20.SCR will bring this fact to light. Question: I make changes to the Dialing Directory but they are not saved. Answer: Changes made to the dialing directory are saved by pressing the F10 key. Please take a look at the status line on the bottom of your screen, which clearly indicates that F10 saves changes, while ESC aborts changes As changes in Qmodem operating procedures are made, explanatory displays are updated to reflect them. Please 264 Appendix A look at the screen more closely when you encounter a problem; the solution may be a few lines away and will save you a telephone call to us in the process. Question: Why does Qmodem turn on HALF Duplex after I connect to a BBS? What controls the Duplex mode? Answer: There are four factors which affect Half and Full Duplex (echo): 1. The modem itself is set to echo. On most modems, ATE1 will cause commands sent to the modem to be echoed back to the system while offline only. ATF0 will set local echo ON after the connection has been established. Usually, ECHO OFF is the modem default. 2. Doing ALT-E causes Qmodem itself to provide local echo. 3. Local Qmodem echo can be set in the Qmodem phone directory. Alt-D, then O to see the alternate screen. The last column on the right is the Duplex mode for that directory entry. Once you connect, you will get echo if that column contains a "H". Change it to "F" and press F10 to save the changed directory entry. 4. The Script commands TURNON ECHO and TURNOFF ECHO can also play a role in setting the local echo. This is usually the one everyone overlooks! Check those Linked Scripts in the dialing directory to see if these are set wrong. This is the last place usually to look, but it will pay to be sure! Question: My HST modem does not connect with 1200 or 2400 non-MNP modems. Either nothing happens, even though the connection is made, or I get a VOICE return from the modem. Answer: The HST always tries to determine if it is talking to another HST first, then if it is talking to another MNP modem. In some cases, this process takes longer than the other modem's carrier/training sequence (the high-pitch sound the modem makes when it first answers your call). As a result, the HST waits forever and eventually times out with a NO CARRIER condition. If you receive a VOICE return code, but the other modem has in fact answered the call, it is possible that background noise in the connection is being interpreted by the HST as voice rather than data. Version 4.0 265 To correct the first problem, issue an AT&N2 command (if you are calling a 1200bps board) or an AT&N3 (2400bps) command while OFFLINE. The HST will return an "OK" following receipt of the command. The HST will no longer try to determine if it is talking to another HST and will force its link rate to whatever fixed speed you set. If you KNOW that the other modem is non-MNP, you may also use the AT&M0 command which effectively disables the HST's MNP capabilities and makes it act exactly like a standard 1200/2400 modem without MNP. The combination AT&N2/AT&N3 and AT&M0 will eliminate many of the problems you may be experiencing connecting with slower non-MNP modems. To correct the VOICE problem, issue the AT&X7 command (the previous setting was AT&X6 which turns on the HST's voice- recognition circuitry). This will prevent the HST from becoming confused. However, it will also prevent the HST from recognizing legitimate voice answers. Question: When dialing out of the phone book, Qmodem does not switch baud rates to what was listed in the directory. Answer: This is directly related to the first Question dealing with the Online / Offline indicator. If the indicator is ONLINE when you go to dial from the phone book (Alt-D), the baud rate will not be switched because Qmodem assumes you are already online! If you are Offline, then the baud rate is changed before placing the call. Question: I press ^C or ^BREAK and I get a ^C in the status line and it will not move until I clear the screen. Why? Answer: You have the DOS BREAK turned on and it must be off so Qmodem can effectively trap the ^C and handle it in an orderly fashion. Just enter the following DOS command before starting Qmodem: C>BREAK OFF<cr> Question: My Hayes 2400B modem will not hang up reliably. Answer: The Hayes 2400B and many clones come from the factory with the DTR signal forced TRUE (always on) and Qmodem wants to control the DTR signal. The most reliable method for hanging up, it to toggle the DTR signal going to the modem. 266 Appendix A On the Hayes 2400 (and 2400B) this is done by sending the following command: AT&D2<cr> Then, go into Setup (Alt-N/M/M/H) and change it to the following: DTR Make sure the letters are capitalized and there are no additional characters, just DTR. Then make sure you exit and Save the Configuration (Alt/N/E/S). Now, when you press Alt-H, the modem will hang up! Question: What's Ymodem-G and 1K-Xmodem-G and why is it these protocols do not show up in the protocol window when I do an up/download. What does it take? Answer: Ymodem-G and 1K-Xmodem-G are protocols which assume that all error corrections are performed by the modem hardware. Many modems are now supporting the MNP (Microcom Networking Protocol) error detection/correction protocol, and most high-speed modems (IE, the USR HST and Hayes V9600) use proprietary error correction techniques at higher speeds. If you have such a modem, you should activate CTS checking via Setup (Alt-N/O/T/C = ON). This will enable the Ymodem-G and 1K-Xmodem-G protocols. However, these can only be used IF the modem at the other end is similarly equipped and a "reliable" connection is e stablished between the two modems. Question: What are the correct settings for the MultiTech 224E modem? Answer: This is the modem initialization string you need to send to your modem: AT&F&E1&E4&B1&R1X1V1S11=50S0=0&W0 You can leave the external switches set as they come from the factory. However, you will need to change some switches Version 4.0 267 inside the modem. With the 4-position dip switch should be set as follows: Dip #1 - Down (CTS normal) Dip #2 - UP (factory default) Dip #3 - Up (wait for dial tone dialing) Dip #4 - Down (factory Default) You really need to read your manual, but this will get you up and running... Be sure to set CTS checking in Setup (Alt-N/O/T/C = ON). Question: What is an Error-Correcting modem? Answer: Error-correcting modems perform error correction and recovery on incoming data by themselves. This is a feature usually implemented in the modem's internal firmware (ROM, for example). The accepted standard for internal modem error correction is MNP (Microcom Networking Protocol), names after the company (Microcom) who developed it. MNP is not a "Fixed" standard, it is available in levels 1 thru 6, with MNP level 3 being the most commonly available implementation. For two modems to establish an error-free connection, they must both support the same MNP level. Higher levels of MNP, however, are compatible with lower levels of the standard. Two modems supporting MNP level 3 and communicating at 2400 (using the Bell 2400 standard) should establish an error- free connection. Error-free connections are usually indicated by the modem's verbal or numeric return code upon connect. A Multitech MNP-equipped modem may, for example, return a CONNECT 2400/RELIABLE message, while a USRobotics HST modem would return a CONNECT 2400/ARQ message upon connect. Although many high-speed modems (IE, 9600bps and above) from different manufacturers may support the same level of MNP, they may use radically different encoding modulation schemes to yield high data transfer rates, which makes them incompatible at high speeds. For example, the Hayes, Microcom, and USR 9600 modems all support MNP level 3, but are unable to communicate with each other at speeds higher than 2400 due to the incompatibility of their proprietary modulation techniques. Most of these 268 Appendix A modems will automatically "fall back" to the lower speed (IE, 2400) where a reliable error-correcting connection can be made. Question: How do I get my Qmodem Registration Number? Answer: This is going to be easy! All you have to do is type "OPEN 1" at the Main Menu of the Forbin Project BBS and your NAME and NUMBER will be shown to you. Copy these two down *exactly* as they are displayed by the BBS. If you want to skip calling our BBS, you can call us during the day and get the same information quickly. Then, next time you are at the DOS prompt on your computer you can initiate the Qmodem registration process. Step 1. (you are at the DOS prompt in the Qmodem directory) Step 2. type "QMODEM REGISTER<enter>" (without the quotes) Step 3. type in the name *exactly* as it was displayed on the BBS and press <enter>. Step 4. type in the number *exactly* as it was displayed and press <enter>. Step 5. enjoy your newly registered copy of Qmodem! If you have a problem or any question, please leave a comment to the Sysop or call us voice at 319-232-4516 during the days. Question: Qmodem displays a "memory allocation" window when it starts. What's happening? Answer: You over-allocated memory in the Alt-N/O/M setup menu. When Qmodem starts, if it does not have sufficient DOS memory, it will re-allocate the memory it DOES find using a best-fit algorithm. In the process, it may reduce the number of scroll lines, script and editor memory allocations, and download buffers. If this is the case, the memory allocation window will be displayed to warn you of this condition. If Qmodem does not usually display the memory allocation window, and you did NOT change memory allocation via Alt- Version 4.0 269 N/O/M then it is likely that something outside Qmodem is using up memory, such as a new resident program, a device driver, more buffers or more environment space, etc... To correct the condition, change your environment OUTSIDE Qmodem to what it was. If you made changes to Qmodem memory allocation, revise them using your own best judgment until Qmodem no longer displays the memory allocation window upon startup. Question: I press [Enter] in the dialing directory, but it does not dial the current entry. It dials another entry. Why? Answer: You have explicitly tagged entries in the directory, probably with the space bar, and you then moved to another directory location where no tagged entries show. When you press [Enter], Qmodem dials tagged entries. If NO entries are tagged, then it dials the current entry. There is a tagged entry count displayed at the top of the Alt-D screen. If it is greater than zero, some entries are tagged. To dial the current number, you must first untag entries by pressing the U key. Question: In Qmodem 3.1a I could start the program with any non-blank command-line parameter to bypass the opening screen delay. This no longer works in Qmodem 4.0. What's wrong? Answer: The opening delay can no longer be defeated in Qmodem 4.0. Although many have tried, the only known method to get around this is to REGISTER your program. You will receive your own Qmodem registration number, and the opening delay will go away after the program has been registered to you. Check the program's documentation for registration info. We appreciate your support. Question: I inadvertently sorted my directory. How do I get back to what it was before? Answer: Undo the sort by pressing Ctrl-U. If you inadvertently sorted your directory TWICE, you're stuck with a sorted directory. If you wish to experiment with the new directory functions, make a copy of your QMODEM.FON file before you start Qmodem. 270 Appendix A Question: I created a logon script with QuickLearn and it does not work. Answer: It is likely that you captured time- or environment- dependent information in the script. For example, one of the prompts captured by QuickLearn contains the amount of time left during your online session. Edit the script manually to remove that part of the prompt. QuickLearn is quick and easy, but it is not intelligent. It records everything that happens between you and the other computer and faithfully replicates it in the script, warts and all. This can cause problems if prompts change or if they contain information that's not likely to be there -- or that will change -- the next time you call. Question: Some of my old scripts don't work. Answer: Qmodem 4.0 has two major changes in how it defines a carriage return and a delay. Previous releases allowed you to use the { and ~ characters. Qmodem 4.0 REQUIRES the ^M as a carriage return and the ^~ as a delay. A utility is included in Qmodem 4.0 to convert old scripts to the new conventions, we suggest you use it and try again. Version 4.0 271 $ 204 8_BIT 249 $$ 204 $ATTR 205 @DIAL 122 $BOARD 102, 206 @EDIT 123, 195 $COM 102, 208 @EDITOR 041, 150 $DATE 054, 204 @FSE 041, 150 $DLPATH 205 @SCRIPT 124 $FAIL 225, 235 @SHELL 122 $LAST_COL 205 @SHELLX 122 $LAST_ROW 205 @STAMP 125 $NOTEFILE 208 $NUMBER 102, 206 Abandon 056 $OFFLINE 234 Abort Dial Command 024 $ONLINE 234 Alt- 001 $PASSWORD 102, 125, 206 Alt-0 047, 125, 175, 249 $PROTOCOL 102, 207 Alt-1 047, 172, 249 $SCPATH 205 Alt-2 117, 173, 214, 225 $SCRIPT 102, 207 Alt-4 117, 173, 214, 225 $SPEED 102, 207 Alt-5 178 $SUCCESS 225, 235 Alt-8 173, 249 $TIME 204 Alt-9 174 $ULPATH 205 Alt-A 082 +++ 024, 118 Alt-B 045, 051, 084, 249 .. (ellipsis) 1 Alt-C 016, 085, 216 .CAP 040 Alt-D 015, 055, 056, 085, 125, 176, .DMP 040 195, 220, 236 .FON 146 Alt-D/L 236 .KEY 059, 120, 237 Alt-D/T 122 .LOG 041 Alt-E 078, 249 .PRE 061 Alt-F 115, 195 Alt-G 048, 116, 233 /AUTOZ 062 Alt-H 118, 176, 234 /F 062 Alt-I 119 /HOST 062 Alt-J 177, 195, 227 /NOINT16 062 Alt-K 127, 176, 241 /NVR 063 Alt-L 177, 215, 224 /S= 195 Alt-M 045, 249 /S=SCRIPT.SCR 063 Alt-N 058, 092, 129 /VEGAVGA=[mode] 063 Alt-N/A 056 /XT 063 Alt-N/C 013, 057 Alt-N/C/C 014 16450 048 Alt-N/C/C/A 014 16550 048, 062 Alt-N/C/C/B 014 16550A 048, 062 Alt-N/C/C/C 015 8-bit 174 Alt-N/C/C/D 015 80286 063 Alt-N/C/C/E 015 80386 063 Alt-N/C/C/F 015 8086/88 063 Alt-N/C/C/G 015 80x25 173, 205, 260 Alt-N/C/C/H 015 80x43 173 Alt-N/C/C/I 015 80x50 173 Alt-N/C/C/J 015 8250 048 Alt-N/C/C/K 016 Alt-N/C/C/L 016 Alt-N/M/M/I 022 Alt-N/C/C/M 016 Alt-N/M/M/P 022, 092, 093 Alt-N/C/C/N 016 Alt-N/M/M/R 025, 057, 101 Alt-N/C/C/O 016 Alt-N/M/M/S 023 Alt-N/C/C/P 016 Alt-N/M/P 019, 021, 025, 241 Alt-N/C/C/Q 016 Alt-N/M/P/x 026 Alt-N/C/C/R 016 Alt-N/M/S 192 Alt-N/D 026, 057 Alt-N/O 042 Alt-N/D/D 027, 034, 205, 223 Alt-N/O/C 043, 054, 105 Alt-N/D/S 027, 063, 116, 205 Alt-N/O/C/A 055 Alt-N/D/U 205 Alt-N/O/C/B 055 Alt-N/E 056 Alt-N/O/C/D 054 Alt-N/E/S 058 Alt-N/O/C/N 056 Alt-N/F 040, 057 Alt-N/O/C/P 055 Alt-N/F/B 041 Alt-N/O/C/S 055 Alt-N/F/C 040 Alt-N/O/C/T 055 Alt-N/F/L 041, 047 Alt-N/O/D 043, 053 Alt-N/F/O 040 Alt-N/O/D/F 053 Alt-N/F/S 040 Alt-N/O/D/S 053 Alt-N/F/U 027 Alt-N/O/E 043 Alt-N/F/V 041, 103 Alt-N/O/M 043, 049 Alt-N/H 028, 179 Alt-N/O/M/D 050 Alt-N/H/A 030 Alt-N/O/M/E 049, 085, 104 Alt-N/H/B 031 Alt-N/O/M/L 049 Alt-N/H/I 030 Alt-N/O/M/O 050 Alt-N/H/K 030 Alt-N/O/M/S 049, 168, 259 Alt-N/H/M 029 Alt-N/O/S 043, 051 Alt-N/H/O 029 Alt-N/O/S/C 051, 052 Alt-N/H/R 030 Alt-N/O/S/C/1 052 Alt-N/H/S 030 Alt-N/O/S/C/2 052 Alt-N/H/T 028 Alt-N/O/S/C/3 052 Alt-N/H/U 029 Alt-N/O/S/D 051 Alt-N/M 018 Alt-N/O/S/U 051 Alt-N/M/C 018, 019, 108 Alt-N/O/T 043, 044, 172, 208 Alt-N/M/C/A 019 Alt-N/O/T/A 045 Alt-N/M/C/B 020 Alt-N/O/T/B 045, 051 Alt-N/M/C/C 020 Alt-N/O/T/C 046, 184 Alt-N/M/C/D 020 Alt-N/O/T/D 047 Alt-N/M/C/E 020 Alt-N/O/T/F 048 Alt-N/M/C/F 020 Alt-N/O/T/G 047 Alt-N/M/C/G 020 Alt-N/O/T/K 048 Alt-N/M/C/H 020, 100, 101, 102 Alt-N/O/T/L 045 Alt-N/M/C/I 021, 181 Alt-N/O/T/P 045 Alt-N/M/C/J 021 Alt-N/O/T/R 046 Alt-N/M/M 018, 022, 057, 100, 101 Alt-N/O/T/S 047 Alt-N/M/M/1 023 Alt-N/O/T/T 046, 047, 199 Alt-N/M/M/2 023 Alt-N/O/T/U 041, 047 Alt-N/M/M/3 023 Alt-N/O/T/V 045 Alt-N/M/M/4 023 Alt-N/O/T/W 046 Alt-N/M/M/A 024 Alt-N/O/T/X 044 Alt-N/M/M/C 023, 101 Alt-N/P 031, 033, 161 Alt-N/M/M/H 024, 118 Alt-N/P/A 034, 159 Alt-N/P/A/R 035 AUTOEXEC.BAT 004, 006, 062 Alt-N/P/A/R/C 035 Alt-N/P/A/R/L 036 Backscroll 041 Alt-N/P/A/R/U 035 BACKSPACE 047, 172 Alt-N/P/A/T 037 Baud Rate 019, 077 Alt-N/P/A/T/B 038 BBS 020, 039, 104, 115, 135, 157, Alt-N/P/A/T/C 037 174, 191, 206, 207 Alt-N/P/A/T/E 039 BEEP 213 Alt-N/P/A/T/L 038 Beeps & Bells 045, 055, 078 Alt-N/P/A/T/P 038 BIOS 190 Alt-N/P/A/T/U 037 BIOS Video 045 Alt-N/P/x 032 BOX 192, 212, 214, 216, 233, 254, Alt-N/P/x/D 032 260 Alt-N/P/x/F 033 BREAK 023, 024, 118, 119, 171, 214 Alt-N/P/x/P 032 Browse 149 Alt-N/P/x/S 032 BS 172 Alt-N/P/x/U 032 BS_DEL 249 Alt-N/S 056 Bulletin Board ii Alt-O 130, 177, 215 BUSY 018, 020, 023 Alt-P 045, 077, 127, 131, 245 Busy Command 031 Alt-Q 002, 093, 132, 194 Alt-R 145, 177, 190, 222 Call-waiting 023 Alt-S 116, 147, 249 CALLBACK 028, 029, 178, 179 Alt-T 148 Capture 040, 153, 170, 215, 238, 249 Alt-U 148, 249 Capture Buffer 078 Alt-V 041, 149, 195 Caret 200 Alt-W 151 Carriage Return 039, 078, 171 Alt-X 129, 152, 177, 247 Carrier detect 234 Alt-X/X 050 CASE 249 Alt-Y 153, 177 CGA 047 Alt-Z 044, 154, 249 Change Subdirectory 131 Alt-[character] 01 Characters 043, 054 ANSI 016, 043, 077, 085, 116, 129, CHAT 178, 187 180, 233 CHDIR 130, 215, 224, 235 ANSI emulation 180 Checksum 159 ANSI Music 045, 055, 078 CLOSED 028 ANSI.SYS 190 CLOSED system 028 ASCII 031, 034, 036, 037, 044, 082, CLOSEFILE 208, 216, 239, 243, 256, 083, 084, 158, 180, 249 258 ASCII downloads 165 CLRSCR 216, 230, 254 ASCII escape character 129 Color 205, 212, 217, 218, 221 ASSIGN 203, 204, 213, 219, 259 Color Graphics v ATA^M 030 COLORBG 217, 218 ATDP 022 COLORFG 218 ATDT 022 Colors 013 ATH 118 COMMAND.COM 005, 145 ATH0 024 Communication Parameters 018 ATWRITE 192, 212, 217, 218, 221, 222 Communication ports 127 AUto Start Log 047 CompuServe 115, 159, 173 Auto-logon script 085 Computers v Auto-Zmodem 062 COMSPEC= 145 Autoexec Script 063 CONFIG.SYS 04 CONNECT 018, 023, 046 DOS prompt 058 Connect Message 023 DOS Shell 153 Connect Speed 024 Double-spaced 171 Connect Tones 051 DoubleDOS 045 CONNECT/2400 023 Dow Jones News/Retrieval 115 CONTROL 200 DOWNLD 223, 224, 235 Copyright ii Download 027, 059, 205, 207, 223, CPS 163 224, 235, 250, 257 CPU 063 Download BAT 032 CR 171 Download Buffer 050 CRT 015 Download Dir 029 Ctrl-Backspace 047 Download Protocols 165 CTRL-END 171, 215 Download tone 051 Ctrl-H 172 DRIVE 216, 224, 235, 257 Ctrl-Home 040, 169, 215 DSZ 034, 156 Ctrl-PgDn 224 DSZ.COM 033, 034 Ctrl-PrtSc 174 DSZ.DOC 033 Ctrl-[character] 01 DTR 024, 118, 119, 153, 241 CTS 046, 156, 160, 161, 184 Dual Async Adapter/A v CTS/RTS Signal 046 Duplex 078, 085, 114 Custom Colors 014 Cycle Delay 020 ECHO 249 Editor marked text 016 Data bits 020, 021, 077 Editor Memory 049 Data Terminal Ready 024 Editor primary text 016 Date Separation 054 Editor window border 016 DEBUG 198, 219, 261 EGA v, 015, 016, 047, 086, 146, 173, DECR 219, 235, 259 192, 214, 225, 257 Default Baud Rate 19 Elapsed-Time 079 Default Data Bits 020 EMS 02 DEFAULT directories 027 Emulation 043 Default Parity 020 Environment variable 06 Default Stop Bits 020 EOL 039 Definitions 01 ERROR 018 DEL 047, 172 Error Messages 257 Del/^H Backspace 047 Error-correcting 019 DELAY 219, 240, 252 Error-correcting modem 046, 156, 161 Delays 043, 053 Error-correction 160 Delphi 115 ESC 01 DESQview 003, 045, 047 EXIST 202, 225 DIAL 220, 221, 236 Exit 056, 226, 232, 243, 247 Dialing Directory 085 EXPNUM 209 Dialing queue 020 External editor 104 DIR 151 External protocols 032, 156, 161 DISPLAY 192, 221, 222, 238, 254, 255, 262 F1 Help 07 DISPLAYLN 192, 221, 222, 238, 254, F11 062 255 F12 062 DNLD 250 FAW 027 Dollar sign 204 FDX 078 DOS 222, 224 Fido 115 DOS Password 029 FIFO 062 FIFO during Shell 048 Implied tagging 087, 088 File Allocation Window 027 INCR 219, 235, 259 File Delete 153 Information text 016 File Transfers 053 Init Command 030 Filename Prompt 033 Initial video mode 063 Find Text 106 Initialization Command 022 FKey 120, 226, 237 INKEY 192, 227, 228, 229, 230, 231, Flow control 078, 154 236 FLUSH 227, 258 INTEGER 192 FON 058 Internal Editor 039, 041, 103, 104 Forbin Project 206 Internal timeout 021 Full Duplex 078, 114 Interrupt 062 Invoice 119 Gateway 149 IRQ 021, 026 GEnie ii, 115, 171 GET 192, 203, 227, 228, 229, 230, Key Definition Files 120 231, 236 Keyboard 062 GETN 192, 203, 227, 228, 230, 231, Keypad emulation 048 236 KEYWORD 210, 259 GETNR 192, 203, 227, 228, 229, 230, 231, 236 LABEL 210, 259, 262 GETR 192, 203, 227, 228, 229, 231, Labels 202 236 LAP-B 160 GETSCR 214, 230, 243, 254, 258 Laptop 013 GETX 192, 203, 227, 228, 229, 230, LCD 013 231 LF 171 GOSUB 202, 210, 232, 244, 261 Linefeed 078, 171, 249 GOTO 202, 210, 232 LineFeed character 039 GOTOXY 221, 233, 260 Linked Script Edit Screen 106 GRAPHICS 233, 259 Linked Scripts 105, 193 Growing Windows 047 LIST 149 LOADFON 236, 258, 260 Half Duplex 078, 114 Loading a new Phone Book 108 Hangup 118, 233, 235 LOADKEY 226, 237, 258, 260 Hangup Command 024 Log 041, 047, 079, 153, 175, 237, Hardware-handshaking 046, 156 246, 249, 260 HDX 078 Logged Drive 131 Help Key 07 LOGOFF.HST 180 Hercules v Logon Scripts 105 High Bit 084 High-speed 019, 046 Macro 120, 194 High-speed modems 021 Mainframe 020, 173 Home 077 Margins 085 Home Menu 081 MasterCard ii Host 062 Maximum Time 029 Host Menu files 180 MCI 090 Host Mode 002, 178 MCI-Mail 115 Host Password (.PWD) file 028 MDA 047 Host Setup 179 Memory 043, 049 MENU.HST 180 IBM compatible v Minicomputer 020, 173 IF 202, 210, 234, 259 MNP 046, 092, 156, 160, 163 Modem cables 161 Port Addresses 019 Modem Command delay 021 Prefix Dial Command 022 Modem Commands 018 Prefixes 086 Modems v PRELOG.HST 180 Monochrome v, 015 PRINT 249 Multi-tasking 003, 045 Printer 174 Music 078, 129, 249 Printer Toggle 079 Music information 129 Printing the Phone Book 111 Music Toggle 078 PRN 111 Protocol 032 Network 046 Protocol Definition window 032 NO CARRIER 018, 023 Protocol Selection Window 032 NO CONNECT 023 Protocols 223 NO DIAL TONE 023 PROTS.HST 180 No Video Restore 063 PS/2 v, 026 Nochange 115 Public Board eXchange 024 Noise 084, 249 Public Domain i NOTE 192, 221, 238, 246 Pulldown edit field 015 Note Files 085, 090, 105 Pulldown first letter 014 Notes Tag 056 Pulldown normal text 014 NUMERIC codes 024 Pulldown selection bar 015 NumLock 048 Pulldown window border 015 NUMVAR 210 Pulse-dialing 022 PUSH 240, 242, 262 OFFLINE 021, 077 PUTSCR 214, 230, 242, 254, 258 OK 018, 021, 030 OK Message 030 QFE 146 Omen Technology 031, 156 QINSTALL 02, 129 On-hook 024 QM.BAT 05 Online 077, 249 QMHOST.BAT 190 Online Help 040 QMHOST.EXE 190 Online Help border 016 QMHOST.HDR 180, 186 Online Help text 016 QMHOST.MSG 180, 186 OPEN 028 QMHOST.PWD 179 OPEN system 028 QMHOST.SCR 187 OPENFILE 208, 216, 238, 243, 256, QMHOSTL.SCR 187, 189 257, 258, 259 QMHOSTPK.EXE 180, 186 Other Info 110 QMODEM.CNF 05, 056, 058 Overlay Buffer 050 QMODEM.EXE i, 05, 058 QMODEM.FON 05 Pacing Speed 038 QMODEM.HLP 05, 040 Parity 020, 021, 077 QMODEM.INI 153 PATH= 006, 034 QMODEM.KEY 05 PAUSE 220, 239, 252 QMODEM.LOG 041 PBX 024, 090, 119 QMODEM.OVR 05 PCBoard 039, 115, 131, 156, 206, 207 QMODEM.PRE 05 PCjr mode 045 QuickLearn 002, 088, 093, 132, 191, PgDn 177, 223 194 PgUp 177 Phone Book Tag 055 RAM disk 050 POP 240, 242 RBBS-PC 115 PORT 241, 261 READFILE 208, 216, 239, 243, 256, Sorting the Phone Book 113 257, 258 Sounds 043, 078 Receive Zmodem 033 Source 173 Redial Hangup Text 025 Speaker 084 Redial Sets Baud Rate 046 Speed 021 Registration ii SPLIT 249 Relaxed Xmodem 159 Split-Screen 116, 147 RETURN 226, 232, 243, 244, 247, 261 SPRINT 090 RING 025, 030 STAMP 178, 238, 246 Ring Detect 030 Status Line 016, 047, 077, 081, 174 ROM BIOS 045 Status Line Filler 055 RTS 046, 160, 161 Status Windows 053 RZ.BAT 033 Stop bits 020, 021, 077 STRING 192, 210, 213, 219, 247, 260 Save Changes 056 Strip/Replace 082 Screen border 015 Subdirectories 130 Screen colors 085 Subscription ii Screen Dump 040 SUBST 224 Screen memory 045 Suffix Dial Command 023 Screen text 016 SuperEGA 173 SCRFIX.EXE 059 SuperVGA 173 Script 085, 178, 187, 209, 243, 244, Sysops i 261 SYSTEM 247, 262 Script files 027, 059 System Clock 079 Script parameters 124 SZ.BAT 033 Script Recorder 093, 132 Script Variables 049 Tag Multiple 095 Scripts 027, 115, 178, 193 Tagged entries 086 SCROLL 249 TaskView/OmniView 03 Scroll-back 049, 148, 167 Technical support 119 Scroll-back buffer 079 Telephone support ii Scroll-back Toggle 079 Terminal emulation 077, 116 Scrolling Region 085 Text Search 104 Select Character 032 Time 055 SEND 059, 192, 207, 245, 254, 255, Time Separation 055 262 Time-of-day 079 Send Zmodem 033 TIMEOUT 248, 252, 253 Sending a file 161 Timeout Delay 020 Serial Port v, 021 Toggles 043, 078 Serial port speed 046 Tone-dial 022 Session Log 079, 175 TopView 03 SET 06 Translation 035, 082 SETCOMM 245, 261 Trial Disk ii SETUP 129 TSR 050, 122 Shell to DOS 145, 190 TTY 043, 116, 233 ShftTab 249 TURNOFF 215, 238, 248, 262 Shift state 120 TURNON 228, 248, 263 Shift-Tab 045, 171 Shutdown Password 030 UART 048, 062, 119 SideKick 146 Un-tagging 088 Site License iv Undo Changes 113 Snow Checking 047 Untag All 098 Up Arrow 148, 167 Zmodem 031, 033, 062 UPGRADE.EXE 058, 105 UPLD 223, 224, 235, 250, 251 [ENTER] 01 qUpload 027, 059, 205, 223, 224, [ESC] 001, 07 235, 249, 260, 263 [Home] 080 Upload BAT 032 Upload Dir 029 ^ 01 Upload Protocols 155 ^End 178 Upload tone 051 ^H 047, 172 Uploading a file 161 ^Home 249 USR Courier HST 019 ^M 023, 024, 057, 118, 147 ^PrtSc 249 Variables 203 ^Q 044 VEGA VGA 063 ^S 044 VERBAL messages 024 ^^ 200, 201 VGA v, 015, 016, 047, 086, 146, 173, ^~ 200 192, 214, 225 ^~^~^~ 118 Video Cards v ^~^~^~+++^~^~^~ATH 118 Video-7 063, 173 View 041 _OFFLINE_ 228, 231 VISA ii VT100 016, 043, 085, 116, 172, 233 { 057 WAITFOR 132, 210, 248, 251, 253 WAITUNTIL 252 Warranty vi WHEN 059, 192, 202, 210, 253, 262 WINDOW 192, 212, 214, 216, 233, 254, 260 Window border 015 Window primary text 015 Window Scroll Bar 015 Window secondary text 015 Windows/386 003, 045 WORD 210 WordStar 149, 194 WRITE 192, 254, 255, 262 WRITEFILE 216, 239, 243, 256, 257, 258 WRITELN 192, 254, 255 X.PC 160 XMODEM 159 Xmodem-1K 159 Xmodem-1K/G 156, 161 Xmodem-CRC 159 Xon/Xoff 044, 078, 154, 249 Ymodem 159 YMODEM batch 159 Ymodem-G 02, 156, 161